dotsync 0.1.13 → 0.1.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6902bf77ffae5ae4fa88c9a35e452207c7ee5fd1cc274690023a5e2622079681
-  data.tar.gz: 024ac7795cae1eee0a342f96b7957a024297d64bac16e1375b7541b0e963e8b5
+  metadata.gz: c1bdf9f9ccaf7c8fb89e69d1e2f8cd95b72bc7b089d2e582fb358a84ebefb6d2
+  data.tar.gz: e05942884ce70c0921c8bfa18f7a9e8be1d8f92ff06912b1f9d09098088ff8fc
 SHA512:
-  metadata.gz: aa928d590ce5a9fc6e7494e9c31c542ed336e0ce7a46afaf3050847acefb9033c9b7812027661e49c963f1cb17204e4b0ab81820ccb2544964aaa1d8159f97ba
-  data.tar.gz: 17d532898d18d4b11a11f649fdfd097f37af75dbd091096b52da9eb6ba420cce28657f37872c912636a71e7206ae391f30c69523a4b59ae214e5fdab9ac54027
+  metadata.gz: f33b7f4c6293a0a50c263560f433f7712f6b7d67f997222db3070c7c72b35837b7ed7d92c1b7fcc3b05574d047db6d4daa8a97bd20438e1237ed9f1ffbd8fba8
+  data.tar.gz: 15e81bab5c0eaba1ab206c7a8c720f1baaacceb1e8ee5429e7ec1df20515329466c1a43949a637a8485219d92578d2e6acefc3768a529aef9136b90ab6d6b34a

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

@@ -34,7 +34,7 @@ jobs:
           bundle exec rubocop
 
       - name: Publish to RubyGems
-        if: matrix.ruby == '3.2'
+        if: matrix.ruby == '3.2' && github.ref_name == 'master'
         run: |
           mkdir -p $HOME/.gem
           touch $HOME/.gem/credentials

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+# 0.1.15
+
+- Readme: update screenshots in docs
+- Consistent order of icons on Legend and Mappings
+- DirectoryDiffer: implements only option
+- Show Flags icons closer
+
+# 0.1.14
+
+- Render environment variables and mappings with a table
+- Added mappings legend
+- Added transfer files with "only" option
+
 # 0.1.13
 
 - PullAction: backup message simplified

data/Gemfile.lock

@@ -1,12 +1,13 @@
 PATH
   remote: .
   specs:
-    dotsync (0.1.13)
+    dotsync (0.1.15)
       fileutils (~> 1.7.3)
       find (~> 0.2.0)
       listen (~> 3.9.0)
       logger (~> 1.7.0)
       ostruct (~> 0.6.3)
+      terminal-table (~> 4.0.0)
       toml-rb (~> 4.0.0)
 
 GEM
@@ -118,6 +119,8 @@ GEM
       rbs (>= 3, < 5)
     ruby-progressbar (1.13.0)
     stringio (3.1.7)
+    terminal-table (4.0.0)
+      unicode-display_width (>= 1.1.1, < 4)
     timecop (0.9.10)
     toml-rb (4.0.0)
       citrus (~> 3.0, > 3.0)

data/README.md

@@ -35,14 +35,14 @@ Dotsync provides the following commands to manage your dotfiles:
 
 - **Push**: Transfer dotfiles from your local machine to the destination repository.
   ```shell
-  dotsync push
+  dotsync push --apply
   ```
 
   ![dotsync push](docs/images/dotsync_push.png)
 
 - **Pull**: Synchronize dotfiles from the repository to your local machine.
   ```shell
-  dotsync pull
+  dotsync pull --apply
   ```
 
   During the `pull` operation, `Dotsync::PullAction` creates a backup of the existing files on the destination. These backups are stored in a directory under the XDG path, with each backup organized by a timestamp. To prevent excessive storage usage, only the 10 most recent backups are retained. Older backups are automatically purged, ensuring efficient storage management.
@@ -72,8 +72,10 @@ ignore = ["nvim"]
 [[pull.mappings]]
 src  = "$XDG_CONFIG_HOME_MIRROR/nvim"
 dest = "$XDG_CONFIG_HOME/nvim"
-force = true  # it forces the deletion of destination folder
-ignore = ["lazy-lock.json"]  # use relative paths to "dest" to ignore files and folders
+# FEATURE: forces the deletion of destination folder
+force = true
+# FEATURE: use relative paths to "dest" to ignore files and folders
+ignore = ["lazy-lock.json"]
 
 [[pull.mappings]]
 src = "$HOME_MIRROR/.zshenv"
@@ -87,6 +89,8 @@ src = "$HOME_MIRROR/.zshenv"
 [[push.mappings]]
 src = "$XDG_CONFIG_HOME/alacritty"
 dest = "$DOTFILES_DIR/config/alacritty"
+# FEATURE: transfer only relative paths of files and folders passed here
+only = ["alacritty.toml", "rose-pine.toml"]
 
 
 [[watch.mappings]]
@@ -110,6 +114,14 @@ dest = "$DOTFILES_DIR/config/alacritty"
 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.
+- **`only`**: An array of files or folders. This option ensures that only the specified files or folders from the `src` directory are transferred to the `dest` directory. Example:
+  ```toml
+  [[push.mappings]]
+  src = "$XDG_CONFIG_HOME"
+  dest = "$DOTFILES_DIR/config"
+  only = ["config.yml", "themes"]
+
+  ```
 - **`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.

data/dotsync.gemspec

@@ -33,6 +33,7 @@ Gem::Specification.new do |spec|
   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_dependency "terminal-table", "~> 4.0.0"
 
   # Debug with:
   # require 'debug'; binding.break

data/lib/dotsync/actions/base_action.rb

@@ -23,6 +23,7 @@ module Dotsync
       def show_options(options)
         info("Options:", icon: :options)
         logger.log("  Apply: #{options[:apply] ? "TRUE" : "FALSE"}")
+        logger.log("")
       end
   end
 end

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

@@ -2,6 +2,15 @@
 
 module Dotsync
   module MappingsTransfer
+    include Dotsync::PathUtils
+
+    LEGEND = [
+      [Dotsync::Icons.force, "The source will overwrite the destination"],
+      [Dotsync::Icons.only, "Paths designated explicitly as source only"],
+      [Dotsync::Icons.ignore, "Paths configured to be ignored in the destination"],
+      [Dotsync::Icons.invalid, "Invalid paths detected in the source or destination"]
+    ]
+
     extend Forwardable # def_delegator
 
     def_delegator :@config, :mappings
@@ -11,17 +20,33 @@ module Dotsync
       return unless env_vars.any?
 
       info("Environment variables:", icon: :env_vars)
-      env_vars.each do |env_var|
-        logger.log("  #{env_var}: #{ENV[env_var]}")
-      end
+
+      rows = env_vars.map { |env_var| [env_var, ENV[env_var]] }.sort_by(&:first)
+      table = Terminal::Table.new(rows: rows)
+      logger.log(table)
+      logger.log("")
+    end
+
+    def show_mappings_legend
+      info("Legend:", icon: :legend)
+      table = Terminal::Table.new(rows: LEGEND)
+      logger.log(table)
+      logger.log("")
     end
 
     def show_mappings
       info("Mappings:", icon: :config)
 
-      mappings.each do |mapping|
-        logger.log("  #{mapping}")
+      rows = mappings.map do |mapping|
+        [
+          mapping.icons,
+          colorize_env_vars(mapping.original_src),
+          colorize_env_vars(mapping.original_dest)
+        ]
       end
+      table = Terminal::Table.new(headings: ["Flags", "Source", "Destination"], rows: rows)
+      logger.log(table)
+      logger.log("")
     end
 
     def show_changes

data/lib/dotsync/actions/pull_action.rb

@@ -9,6 +9,7 @@ module Dotsync
     def execute(options = {})
       show_options(options)
       show_env_vars
+      show_mappings_legend
       show_mappings
       show_changes
       return unless options[:apply]
@@ -19,7 +20,7 @@ module Dotsync
       end
 
       transfer_mappings
-      action("Dotfiles pulled")
+      action("Mappings pulled", icon: :done)
     end
 
     private

data/lib/dotsync/actions/push_action.rb

@@ -7,12 +7,13 @@ module Dotsync
     def execute(options = {})
       show_options(options)
       show_env_vars
+      show_mappings_legend
       show_mappings
       show_changes
       return unless options[:apply]
 
       transfer_mappings
-      action("Dotfiles pushed", icon: :copy)
+      action("Mappings pushed", icon: :done)
     end
   end
 end

data/lib/dotsync/actions/watch_action.rb

@@ -2,6 +2,8 @@
 
 module Dotsync
   class WatchAction < BaseAction
+    include Dotsync::MappingsTransfer
+
     def_delegator :@config, :mappings
 
     def initialize(config, logger)
@@ -11,7 +13,8 @@ module Dotsync
     end
 
     def execute
-      show_config
+      show_mappings_legend
+      show_mappings
 
       @listeners.each(&:start)
 
@@ -21,11 +24,6 @@ module Dotsync
     end
 
     private
-      def show_config
-        logger.info("Mappings:", icon: :config)
-        mappings.each { |mapping| logger.log("  #{mapping}") }
-      end
-
       def setup_listeners
         @listeners = mappings.map do |mapping|
           src = mapping.src

data/lib/dotsync/icons.rb

@@ -9,11 +9,13 @@ module Dotsync
     # Configuration icon
     OPTIONS = " "
     ENV_VARS = " "
+    LEGEND = " "
     CONFIG = " "
     DIFF = " "
 
-    # Default Mapping icons
+    # Default Mapping Flags icons
     DEFAULT_FORCE = "󰁪 "
+    DEFAULT_ONLY = " "
     DEFAULT_IGNORE = "󰈉 "
     DEFAULT_INVALID = "󱏏 "
 
@@ -38,6 +40,7 @@ module Dotsync
     def self.load_custom_icons(config)
       @custom_icons = {
         force: config.dig("icons", "force") || DEFAULT_FORCE,
+        only: config.dig("icons", "only") || DEFAULT_ONLY,
         ignore: config.dig("icons", "ignore") || DEFAULT_IGNORE,
         invalid: config.dig("icons", "invalid") || DEFAULT_INVALID
       }
@@ -47,6 +50,10 @@ module Dotsync
       @custom_icons[:force] || DEFAULT_FORCE
     end
 
+    def self.only
+      @custom_icons[:only] || DEFAULT_ONLY
+    end
+
     def self.ignore
       @custom_icons[:ignore] || DEFAULT_IGNORE
     end
@@ -61,6 +68,7 @@ module Dotsync
       error: ERROR,
       env_vars: ENV_VARS,
       options: OPTIONS,
+      legend: LEGEND,
       config: CONFIG,
       diff: DIFF,
       force: -> { force },

data/lib/dotsync/models/mapping.rb

@@ -4,18 +4,20 @@ module Dotsync
   class Mapping
     include Dotsync::PathUtils
 
-    attr_reader :original_src, :original_dest, :original_ignores
+    attr_reader :original_src, :original_dest, :original_ignores, :original_only
 
     def initialize(attributes)
       @original_src = attributes["src"]
       @original_dest = attributes["dest"]
       @original_ignores = Array(attributes["ignore"])
+      @original_only = Array(attributes["only"])
       @force = attributes["force"] || false
 
-      @sanitized_src, @sanitized_dest, @sanitized_ignore = process_paths(
+      @sanitized_src, @sanitized_dest, @sanitized_ignores, @sanitized_only = process_paths(
         @original_src,
         @original_dest,
-        @original_ignores
+        @original_ignores,
+        @original_only
       )
     end
 
@@ -28,7 +30,11 @@ module Dotsync
     end
 
     def ignores
-      @sanitized_ignore
+      @sanitized_ignores
+    end
+
+    def inclusions
+      @sanitized_only
     end
 
     def force?
@@ -69,14 +75,27 @@ module Dotsync
       File.basename(dest)
     end
 
-    def to_s
-      colorized_src = colorize_env_vars(original_src)
-      colorized_dest = colorize_env_vars(original_dest)
-      msg = ["#{colorized_src} → #{colorized_dest}"]
+    def icons
+      msg = []
       msg << Icons.force if force?
-      msg << Icons.ignore if ignores?
+      msg << Icons.only if has_inclusions?
+      msg << Icons.ignore if has_ignores?
       msg << Icons.invalid unless valid?
-      msg.join(" ")
+      msg.join
+    end
+
+    def to_s
+      msg = "#{decorated_src} → #{decorated_dest}"
+      msg += " #{icons}" if icons != ""
+      msg
+    end
+
+    def decorated_src
+      colorize_env_vars(original_src)
+    end
+
+    def decorated_dest
+      colorize_env_vars(original_dest)
     end
 
     def apply_to(path)
@@ -90,22 +109,46 @@ module Dotsync
         "src" => File.join(@original_src, relative_path),
         "dest" => File.join(@original_dest, relative_path),
         "force" => @force,
+        "only" => @only,
         "ignore" => @original_ignores
       )
     end
 
+    def include?(path)
+      return true unless has_inclusions?
+      return true if path == src
+      inclusions.any? { |inclusion| path_is_parent_or_same?(inclusion, path) }
+    end
+
+    def bidirectional_include?(path)
+      return true unless has_inclusions?
+      return true if path == src
+      inclusions.any? { |inclusion| path_is_parent_or_same?(inclusion, path) || path_is_parent_or_same?(path, inclusion) }
+    end
+
+    def ignore?(path)
+      ignores.any? { |ignore| path.start_with?(ignore) }
+    end
+
     private
-      def ignores?
+      def has_ignores?
         @original_ignores.any?
       end
 
-      def process_paths(src, dest, ignores)
-        sanitized_src = sanitize_path(src)
-        sanitized_dest = sanitize_path(dest)
-        sanitized_ignore = ignores.flat_map do |path|
+      def has_inclusions?
+        @original_only.any?
+      end
+
+      def process_paths(raw_src, raw_dest, raw_ignores, raw_only)
+        sanitized_src = sanitize_path(raw_src)
+        sanitized_dest = sanitize_path(raw_dest)
+        sanitized_ignores = raw_ignores.flat_map do |path|
           [File.join(sanitized_src, path), File.join(sanitized_dest, path)]
         end
-        [sanitized_src, sanitized_dest, sanitized_ignore]
+        sanitized_only = raw_only.map do |path|
+          File.join(sanitized_src, path)
+        end
+        [sanitized_src, sanitized_dest, sanitized_ignores, sanitized_only]
       end
   end
 end

data/lib/dotsync/utils/directory_differ.rb

@@ -36,6 +36,11 @@ module Dotsync
         Find.find(mapping_src) do |src_path|
           rel_path = src_path.sub(/^#{Regexp.escape(mapping_src)}\/?/, "")
 
+          unless @mapping.include?(src_path)
+            Find.prune
+            next
+          end
+
           dest_path = File.join(mapping_dest, rel_path)
 
           if !File.exist?(dest_path)

data/lib/dotsync/utils/file_transfer.rb

@@ -2,8 +2,6 @@
 
 module Dotsync
   class FileTransfer
-    attr_reader :ignores
-
     # Initializes a new FileTransfer instance
     #
     # @param mapping [Dotsync::Mapping] the mapping object containing source, destination, force, and ignore details
@@ -12,9 +10,11 @@ module Dotsync
     # @option mapping [Boolean] :force? optional flag to force actions
     # @option mapping [Array<String>] :ignores optional list of files/directories to ignore
     def initialize(mapping)
+      @mapping = mapping
       @src = mapping.src
       @dest = mapping.dest
       @force = mapping.force?
+      @inclusions = mapping.inclusions || []
       @ignores = mapping.ignores || []
     end
 
@@ -28,6 +28,8 @@ module Dotsync
     end
 
     private
+      attr_reader :mapping, :ignores
+
       def transfer_file(file_src, file_dest)
         FileUtils.mkdir_p(File.dirname(file_dest))
         FileUtils.cp(file_src, file_dest)
@@ -35,11 +37,17 @@ module Dotsync
 
       def transfer_folder(folder_src, folder_dest)
         FileUtils.mkdir_p(folder_dest)
+
+        # `Dir.glob("#{folder_src}/*")` retrieves only the immediate contents
+        # (files and directories) within the specified directory (`folder_src`),
+        # without descending into subdirectories.
+
         Dir.glob("#{folder_src}/*", File::FNM_DOTMATCH).each do |path|
           next if [".", ".."].include?(File.basename(path))
 
           full_path = File.expand_path(path)
-          next if ignore?(full_path)
+          next unless mapping.bidirectional_include?(full_path)
+          next if mapping.ignore?(full_path)
 
           target = File.join(folder_dest, File.basename(path))
           if File.file?(full_path)
@@ -75,9 +83,5 @@ module Dotsync
           end
         end
       end
-
-      def ignore?(path)
-        @ignores.any? { |ignore| path.start_with?(ignore) }
-      end
   end
 end

data/lib/dotsync/utils/path_utils.rb

@@ -24,6 +24,12 @@ module Dotsync
       paths.map { |path| File.join(base_path, path) }
     end
 
+    def path_is_parent_or_same?(parent, child)
+      parent = Pathname.new(parent).expand_path
+      child  = Pathname.new(child).expand_path
+      child.ascend.any? { |ancestor| ancestor == parent }
+    end
+
     # Translates /tmp paths to /private/tmp paths on macOS
     # Retains other paths as-is
     # @param [String] path The input path to translate

data/lib/dotsync/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Dotsync
-  VERSION = "0.1.13"
+  VERSION = "0.1.15"
 end

data/lib/dotsync.rb

@@ -8,6 +8,14 @@ require "logger"
 require "forwardable" # Ruby standard library
 require "ostruct"
 require "find"
+require "terminal-table"
+
+# Base classes
+require_relative "dotsync/errors"
+require_relative "dotsync/icons"
+require_relative "dotsync/colors"
+require_relative "dotsync/runner"
+require_relative "dotsync/version"
 
 # Utils
 require_relative "dotsync/utils/path_utils"
@@ -37,13 +45,6 @@ require_relative "dotsync/actions/pull_action"
 require_relative "dotsync/actions/push_action"
 require_relative "dotsync/actions/watch_action"
 
-# Base classes
-require_relative "dotsync/errors"
-require_relative "dotsync/icons"
-require_relative "dotsync/colors"
-require_relative "dotsync/runner"
-require_relative "dotsync/version"
-
 module Dotsync
   class << self
     attr_writer :config_path

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dotsync
 version: !ruby/object:Gem::Version
-  version: 0.1.13
+  version: 0.1.15
 platform: ruby
 authors:
 - David Sáenz
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-11-04 00:00:00.000000000 Z
+date: 2025-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: toml-rb
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
 - !ruby/object:Gem::Dependency
   name: debug
   requirement: !ruby/object:Gem::Requirement