dotsync 0.1.8 → 0.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d19236d9990f40338b046f38198ddee169c172ec1d57f8914661af46c758c4d
-  data.tar.gz: 1999643c1f8ce059eb4e51fc6699005630d6c7a575fbd58a60f018a88b80174e
+  metadata.gz: b33c80703154eb2790585883479456053089abb500f1891c528a3627a12a2dc2
+  data.tar.gz: 64517cdc665c5ec5fa7657b4e1d197914bf7ad0a6b36dfb690f5cbc2451b0f43
 SHA512:
-  metadata.gz: '03262956f985e6aa2b2e82de93546f75aa6ea45964f976561a2d53464b6c3a27a28a0a3b06135a3305b0f932b8316b2ec58b414234fc016fd3412542ef8e3182'
-  data.tar.gz: 46e24ab637d1ea4c7217ce4e5c318b268b5aebeac36f166c4944bbc3434d4dcfdf2021af54e57e6840d1d889f94f997c6b5208e67d8cee444618384c3dcea65a
+  metadata.gz: '08422291669fb72a90a91826c09411dc4d0ab0174e6b219bc7b8358f95a94db0b9f39d63c2c2e2182e2aea2b7acd19f53c1ca606bb34ab6900298d74402f361b'
+  data.tar.gz: 26bff9d8f479ccf0168d7c93f2cc053b517c978a9566a1f5f02718a4ae4bfc1e1b9dac17e02933dfcb27726798c3fc91acde7df87b96b70cb405a438eec6d42c

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+# 0.1.10
+
+- Readme: add screenshot for PushAction
+- Readme: fixes character on sample config file
+
+# 0.1.9
+
+- Exe: improved banner with options
+- Options: added "--apply"
+- Options: added "--environment-variables"
+- Differ: show full path using original mapping paths
+- Readme: add gem version badge
+- Readme: add requirements section
+
 # 0.1.8
 
 - Show full relative path on diff

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dotsync (0.1.8)
+    dotsync (0.1.10)
       fileutils (~> 1.7.3)
       find (~> 0.2.0)
       listen (~> 3.9.0)

data/README.md

@@ -1,11 +1,16 @@
 # Dotsync
 
-**⚠️ Warning: This gem is under active development. You can expect new changes that may not be backward-compatible.**
-
+[![Gem Version](https://badge.fury.io/rb/sidekiq.svg)](https://rubygems.org/gems/sidekiq)
 [![Ruby Gem Test Status](https://github.com/dsaenztagarro/dotsync/actions/workflows/gem-push.yml/badge.svg)](https://github.com/dsaenztagarro/dotsync/actions)
 
+> [!WARNING]
+> This gem is under active development. You can expect new changes that may not be backward-compatible.
+
 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.
 
+## Requirements
+- Ruby: MRI 3.2+
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -33,6 +38,8 @@ Dotsync provides the following commands to manage your dotfiles:
   dotsync push
   ```
 
+  ![dotsync push](docs/images/dotsync_push_apply.png)
+
 - **Pull**: Synchronize dotfiles from the repository to your local machine.
   ```shell
   dotsync pull
@@ -55,25 +62,42 @@ Dotsync provides the following commands to manage your dotfiles:
 The configuration file uses a `mappings` structure to define the source and destination of your dotfiles. Here is an example:
 
 ```toml
-[pull]
-mappings = [
-  { src = "$DOTFILES_DIR/config/", dest = "$XDG_CONFIG_HOME", force = false },
-  { src = "$DOTFILES_DIR/home/.zshenv", dest = "$HOME" }
-]
-
-[push]
-mappings = [
-  { src = "$HOME/.zshenv", dest = "$DOTFILES_DIR/home/.zshenv" },
-  { src = "$XDG_CONFIG_HOME/alacritty", dest = "$DOTFILES_DIR/config/alacritty" }
-]
-
-[watch]
-mappings = [
-  { src = "$HOME/.zshenv", dest = "$DOTFILES_DIR/home/.zshenv" },
-  { src = "$XDG_CONFIG_HOME/alacritty", dest = "$DOTFILES_DIR/config/alacritty" }
-]
+[[pull.mappings]]
+src = "$XDG_CONFIG_HOME_MIRROR"
+dest = "$XDG_CONFIG_HOME"
+
+[[pull.mappings]]
+src = "$HOME_MIRROR/.zshenv"
+dest = "$HOME"
+
+
+[[push.mappings]]
+src = "$HOME/.zshenv"
+src = "$HOME_MIRROR/.zshenv"
+
+[[push.mappings]]
+src = "$XDG_CONFIG_HOME/alacritty"
+dest = "$DOTFILES_DIR/config/alacritty"
+force = true # it forces the deletion of destination folder
+ignore = ["themes/rose-pine.toml"] # use relative paths to "dest" to ignore files and folders
+
+
+[[watch.mappings]]
+src = "$HOME/.zshenv"
+src = "$HOME_MIRROR/.zshenv"
+
+[[watch.mappings]]
+src = "$XDG_CONFIG_HOME/alacritty"
+dest = "$DOTFILES_DIR/config/alacritty"
 ```
 
+> [!TIP]
+> I use mirror environment variables to cleaner configuration
+>
+>  ```bash
+>  export XDG_CONFIG_HOME_MIRROR="$HOME/Code/dotfiles/xdg_config_home"
+>  ```
+
 #### `force` and `ignore` Options in Mappings
 
 Each mapping entry supports the following options:

data/exe/dotsync

@@ -4,7 +4,7 @@
 require_relative "../lib/dotsync"
 require "optparse"
 
-{}
+options = { apply: false }
 
 opt_parser = OptionParser.new do |opts|
   opts.banner = <<~BANNER
@@ -16,10 +16,18 @@ opt_parser = OptionParser.new do |opts|
       pull   Download remote changes to the local
       watch  Continuously monitor and sync changes
       setup  Initialize a default configuration file
+
+    Options:
+      -a, --apply   Apply changes (push or pull)
+      -h, --help    Show this help message
   BANNER
 
+  opts.on("-a", "--apply", "Apply changes (push or pull)") do
+    options[:apply] = true
+  end
+
   opts.on("-h", "--help", "Show this help message") do
-    puts opts
+    puts opt_parser.banner
     exit
   end
 end
@@ -30,9 +38,9 @@ command = ARGV.shift
 
 case command
 when "push"
-  Dotsync::Runner.new.run(:push)
+  Dotsync::Runner.new.run(:push, options)
 when "pull"
-  Dotsync::Runner.new.run(:pull)
+  Dotsync::Runner.new.run(:pull, options)
 when "watch"
   Dotsync::Runner.new.run(:watch)
 when "setup"

data/lib/dotsync/actions/base_action.rb

@@ -18,5 +18,14 @@ module Dotsync
     def execute
       raise NotImplementedError
     end
+
+    private
+      def show_options(options)
+        info("Options:", icon: :options)
+        logger.log("  Apply: #{options[:apply] ? "TRUE" : "FALSE"}")
+      end
+
+      def show_env_vars
+      end
   end
 end

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

@@ -6,6 +6,16 @@ module Dotsync
 
     def_delegator :@config, :mappings
 
+    def show_env_vars
+      env_vars = mappings_env_vars
+      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
+    end
+
     def show_mappings
       info("Mappings:", icon: :config)
 
@@ -38,8 +48,17 @@ module Dotsync
       end
     end
 
-    def valid_mappings
-      mappings.select(&:valid?)
-    end
+    private
+      def mappings_env_vars
+        paths = mappings.flat_map do |mapping|
+          [mapping.original_src, mapping.original_dest]
+        end
+
+        paths.flat_map { |path| extract_env_vars(path) }.uniq
+      end
+
+      def valid_mappings
+        mappings.select(&:valid?)
+      end
   end
 end

data/lib/dotsync/actions/pull_action.rb

@@ -6,27 +6,23 @@ module Dotsync
 
     def_delegator :@config, :backups_root
 
-    def execute
-      show_config
+    def execute(options = {})
+      show_options(options)
+      show_env_vars
+      show_mappings
       show_changes
+      return unless options[:apply]
+
       if create_backup
         show_backup
         purge_old_backups
       end
-      pull_dotfiles
+
+      transfer_mappings
+      action("Dotfiles pulled")
     end
 
     private
-      def show_config
-        show_mappings
-      end
-
-      def pull_dotfiles
-        transfer_mappings
-
-        action("Dotfiles pulled")
-      end
-
       def show_backup
         action("Backup created:")
         logger.log("  #{backup_root_path}")

data/lib/dotsync/actions/push_action.rb

@@ -4,21 +4,15 @@ module Dotsync
   class PushAction < BaseAction
     include MappingsTransfer
 
-    def execute
-      show_config
+    def execute(options = {})
+      show_options(options)
+      show_env_vars
+      show_mappings
       show_changes
-      push_dotfiles
-    end
-
-    private
-      def show_config
-        show_mappings
-      end
+      return unless options[:apply]
 
-      def push_dotfiles
-        transfer_mappings
-
-        action("Dotfiles pushed", icon: :copy)
-      end
+      transfer_mappings
+      action("Dotfiles pushed", icon: :copy)
+    end
   end
 end

data/lib/dotsync/config/{xdg_base_directory_spec.rb → concerns/xdg_base_directory.rb}

@@ -2,20 +2,20 @@
 
 module Dotsync
   # https://specifications.freedesktop.org/basedir-spec/latest/
-  module XDGBaseDirectorySpec
+  module XDGBaseDirectory
     def xdg_data_home
       File.expand_path(ENV["XDG_DATA_HOME"] || "$HOME/.local/share")
     end
 
-    def xdf_config_home
+    def xdg_config_home
       File.expand_path(ENV["XDG_CONFIG_HOME"] || "$HOME/.config")
     end
 
-    def xdf_cache_home
+    def xdg_cache_home
       File.expand_path(ENV["XDG_CACHE_HOME"] || "$HOME/.cache")
     end
 
-    def xdf_bin_home
+    def xdg_bin_home
       File.expand_path(ENV["XDG_BIN_HOME"] || "$HOME/.local/bin")
     end
   end

data/lib/dotsync/config/pull_action_config.rb

@@ -2,7 +2,7 @@
 
 module Dotsync
   class PullActionConfig < BaseConfig
-    include XDGBaseDirectorySpec
+    include XDGBaseDirectory
 
     def mappings
       mappings_list = section["mappings"]

data/lib/dotsync/icons.rb

@@ -7,6 +7,8 @@ module Dotsync
     ERROR = " "
 
     # Configuration icon
+    OPTIONS = " "
+    ENV_VARS = " "
     CONFIG = " "
     DIFF = " "
 
@@ -20,8 +22,8 @@ module Dotsync
     PUSH = " "
     WATCH = "󰛐 "
 
-    # TODO: review icons needed
     CONSOLE = "󰆍 "
+    # TODO: review icons needed
     LISTEN = " "
     SOURCE = " " #  "
     DEST = " " # " "
@@ -57,6 +59,8 @@ module Dotsync
     MAPPINGS = {
       info: INFO,
       error: ERROR,
+      env_vars: ENV_VARS,
+      options: OPTIONS,
       config: CONFIG,
       diff: DIFF,
       force: -> { force },

data/lib/dotsync/models/mapping.rb

@@ -12,9 +12,11 @@ module Dotsync
       @original_ignores = Array(attributes["ignore"])
       @force = attributes["force"] || false
 
-      @sanitized_src = sanitize_path(@original_src)
-      @sanitized_dest = sanitize_path(@original_dest)
-      @sanitized_ignore = @original_ignores.map { |path| File.join(@sanitized_src, path) }
+      @sanitized_src, @sanitized_dest, @sanitized_ignore = process_paths(
+        @original_src,
+        @original_dest,
+        @original_ignores
+      )
     end
 
     def src
@@ -33,10 +35,17 @@ module Dotsync
       @force
     end
 
+    def directories?
+      File.directory?(src) && File.directory?(dest)
+    end
+
+    def files?
+      return true if File.file?(src) && File.file?(dest)
+      File.file?(src) && !File.exist?(dest) && File.directory?(File.dirname(dest))
+    end
+
     def valid?
-      (File.file?(src) && File.file?(dest)) ||
-      (File.directory?(src) && File.directory?(dest)) ||
-      (File.file?(src) && !File.exist?(dest) && File.directory?(File.dirname(dest)))
+      directories? || files?
     end
 
     def backup_possible?
@@ -78,5 +87,12 @@ module Dotsync
       def ignores?
         @original_ignores.any?
       end
+
+      def process_paths(src, dest, ignores)
+        sanitized_src = sanitize_path(src)
+        sanitized_dest = sanitize_path(dest)
+        sanitized_ignore = ignores.map { |path| File.join(sanitized_src, path) }
+        [sanitized_src, sanitized_dest, sanitized_ignore]
+      end
   end
 end

data/lib/dotsync/runner.rb

@@ -7,7 +7,7 @@ module Dotsync
     end
 
     # action_name should be a symbol, e.g., :pull, :watch, :sync
-    def run(action_name)
+    def run(action_name, options = {})
       case action_name
       when :setup
         setup_config
@@ -22,7 +22,7 @@ module Dotsync
 
           action = action_class.new(config, @logger)
 
-          action.execute
+          action.execute(options)
         rescue ConfigError => e
           @logger.error("[#{action_name}] config error:")
           @logger.info(e.message)
@@ -46,21 +46,28 @@ module Dotsync
         FileUtils.mkdir_p(File.dirname(config_path))
 
         example_mappings = {
+          "icons" => {
+            "options" => "⚙️",
+            "config" => "📄",
+            "force" => "🔥",
+            "ignore" => "🚫",
+            "invalid" => "❌"
+          },
           "pull" => {
             "mappings" => [
-              { "src" => "$DOTFILES_DIR/config/", "dest" => "$XDG_CONFIG_HOME", "force" => false },
-              { "src" => "$DOTFILES_DIR/home/.zshenv", "dest" => "$HOME" }
+              { "src" => "$XDG_CONFIG_HOME_MIRROR", "dest" => "$XDG_CONFIG_HOME" },
+              { "src" => "$HOME_MIRROR/.zshenv", "dest" => "$HOME" }
             ],
           },
           "push" => {
             "mappings" => [
               { "src" => "$HOME/.zshenv", "dest" => "$DOTFILES_DIR/home/.zshenv" },
-              { "src" => "$XDG_CONFIG_HOME/alacritty", "dest" => "$DOTFILES_DIR/config/alacritty" }
+              { "src" => "$XDG_CONFIG_HOME/alacritty", "dest" => "$XDG_CONFIG_HOME_MIRROR/alacritty" }
             ]
           },
           "watch" => {
             "mappings" => [
-              { "src" => "$HOME/.zshenv", "dest" => "$DOTFILES_DIR/home/.zshenv" },
+              { "src" => "$HOME/.zshenv", "dest" => "$HOME_MIRROR/.zshenv" },
               { "src" => "$XDG_CONFIG_HOME/alacritty", "dest" => "$DOTFILES_DIR/config/alacritty" }
             ]
           }

data/lib/dotsync/utils/directory_differ.rb

@@ -1,113 +1,84 @@
 # frozen_string_literal: true
 
 module Dotsync
-  # Usage:
-  # differ = DirectoryDiffer.new("/path/to/src", "/path/to/dest")
-  # differences = differ.diff
   class DirectoryDiffer
     extend Forwardable
 
-    attr_reader :src, :dest
+    # attr_reader :src, :dest
 
-    def_delegator @mapping, :original_src
-    def_delegator @mapping, :original_dest
+    def_delegator :@mapping, :src, :mapping_src
+    def_delegator :@mapping, :dest, :mapping_dest
+    def_delegator :@mapping, :original_src, :mapping_original_src
+    def_delegator :@mapping, :original_dest, :mapping_original_dest
+    def_delegator :@mapping, :force?, :force?
+    def_delegator :@mapping, :original_ignores, :ignores
 
-    # Initializes a new DirectoryDiffer.
-    #
-    # @param mapping [Dotsync::Mapping] the mapping object containing source, destination, force, and ignore details
-    # @option mapping [String] :src the source directory path
-    # @option mapping [String] :dest the destination directory path
-    # @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?
-      @ignores = mapping.original_ignores || []
     end
 
     def diff
-      additions = []
-      modifications = []
-      removals = []
+      if @mapping.directories?
+        diff_mapping_directories
+      elsif @mapping.files?
+        diff_mapping_files
+      end
+    end
+
+    private
+      def diff_mapping_directories
+        additions = []
+        modifications = []
+        removals = []
 
-      Find.find(src) do |src_path|
-        rel_path = src_path.sub(/^#{Regexp.escape(src)}\/?/, "")
-        next if rel_path.empty?
+        Find.find(mapping_src) do |src_path|
+          rel_path = src_path.sub(/^#{Regexp.escape(mapping_src)}\/?/, "")
 
-        dest_path = File.join(dest, rel_path)
+          dest_path = File.join(mapping_dest, rel_path)
 
-        if !File.exist?(dest_path)
-          additions << rel_path
-        elsif File.file?(src_path) && File.file?(dest_path)
-          if File.size(src_path) != File.size(dest_path)
-            modifications << rel_path
+          if !File.exist?(dest_path)
+            additions << rel_path
+          elsif File.file?(src_path) && File.file?(dest_path)
+            if File.size(src_path) != File.size(dest_path)
+              modifications << rel_path
+            end
           end
         end
-      end
 
-      if @force
-        Find.find(dest) do |dest_path|
-          rel_path = dest_path.sub(/^#{Regexp.escape(dest)}\/?/, "")
-          next if rel_path.empty?
+        if force?
+          Find.find(mapping_dest) do |dest_path|
+            rel_path = dest_path.sub(/^#{Regexp.escape(mapping_dest)}\/?/, "")
+            next if rel_path.empty?
 
-          src_path = File.join(src, rel_path)
+            src_path = File.join(mapping_src, rel_path)
 
-          if !File.exist?(src_path)
-            removals << rel_path
+            if !File.exist?(src_path)
+              removals << rel_path
+            end
           end
         end
-      end
-
-      if @ignores.any?
-        additions = filter_paths(additions, @ignores)
-        modifications = filter_paths(modifications, @ignores)
-        removals = filter_paths(removals, @ignores)
-      end
-
-      additions.map! { |rel_path| File.join(@mapping.original_dest, rel_path) }
-      modifications.map! { |rel_path| File.join(@mapping.original_dest, rel_path) }
-      removals.map! { |rel_path| File.join(@mapping.original_dest, rel_path) }
-
-      Dotsync::Diff.new(additions: additions, modifications: modifications, removals: removals)
-    end
 
-    private
-      def collect_src_diffs
-        diffs = []
-        Find.find(src) do |src_path|
-          rel_path = src_path.sub(/^#{Regexp.escape(src)}\/?/, "")
-          next if rel_path.empty?
+        if ignores.any?
+          additions = filter_paths(additions, ignores)
+          modifications = filter_paths(modifications, ignores)
+          removals = filter_paths(removals, ignores)
+        end
 
-          dest_path = File.join(dest, rel_path)
+        additions.map! { |rel_path| File.join(mapping_original_dest, rel_path) }
+        modifications.map! { |rel_path| File.join(mapping_original_dest, rel_path) }
+        removals.map! { |rel_path| File.join(mapping_original_src, rel_path) }
 
-          if !File.exist?(dest_path)
-            diffs << rel_path
-          elsif File.directory?(src_path) && !File.directory?(dest_path)
-            diffs << rel_path
-          elsif File.file?(src_path) && !File.file?(dest_path)
-            diffs << rel_path
-          elsif File.file?(src_path) && File.file?(dest_path)
-            if File.size(src_path) != File.size(dest_path)
-              diffs << rel_path
-            end
-          end
-        end
-        diffs
+        Dotsync::Diff.new(additions: additions, modifications: modifications, removals: removals)
       end
 
-      def collect_dest_diffs
-        diffs = []
-        Find.find(dest) do |dest_path|
-          rel_path = dest_path.sub(/^#{Regexp.escape(dest)}\/?/, "")
-          next if rel_path.empty?
-          src_path = File.join(src, rel_path)
-          if !File.exist?(src_path)
-            diffs << rel_path
+      def diff_mapping_files
+        Dotsync::Diff.new.tap do |diff|
+          if !File.exist?(@mapping.dest)
+            diff.additions << @mapping.original_dest
+          else
+            diff.modifications << @mapping.original_dest
           end
         end
-        diffs
       end
 
       def filter_paths(all_paths, ignore_paths)

data/lib/dotsync/utils/path_utils.rb

@@ -8,6 +8,10 @@ module Dotsync
       path.gsub(/\$(\w+)/) { ENV[$1] }
     end
 
+    def extract_env_vars(path)
+      path.scan(/\$(\w+)/).flatten
+    end
+
     def colorize_env_vars(path)
       path.gsub(/\$(\w+)/) { "\e[38;5;#{ENV_VARS_COLOR}m$#{$1}\e[0m" }
     end

data/lib/dotsync/version.rb

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

data/lib/dotsync.rb

@@ -19,8 +19,10 @@ require_relative "dotsync/utils/path_utils"
 require_relative "dotsync/models/mapping"
 require_relative "dotsync/models/diff"
 
+# Config Concerns
+require_relative "dotsync/config/concerns/xdg_base_directory"
+
 # Config
-require_relative "dotsync/config/xdg_base_directory_spec"
 require_relative "dotsync/config/base_config"
 require_relative "dotsync/config/pull_action_config"
 require_relative "dotsync/config/push_action_config"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dotsync
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.10
 platform: ruby
 authors:
 - David Sáenz
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-10-29 00:00:00.000000000 Z
+date: 2025-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: toml-rb
@@ -244,6 +244,7 @@ files:
 - README.md
 - RELEASING.md
 - Rakefile
+- docs/images/dotsync_push_apply.png
 - dotsync.gemspec
 - exe/console
 - exe/dotsync
@@ -256,10 +257,10 @@ files:
 - lib/dotsync/actions/watch_action.rb
 - lib/dotsync/colors.rb
 - lib/dotsync/config/base_config.rb
+- lib/dotsync/config/concerns/xdg_base_directory.rb
 - lib/dotsync/config/pull_action_config.rb
 - lib/dotsync/config/push_action_config.rb
 - lib/dotsync/config/watch_action_config.rb
-- lib/dotsync/config/xdg_base_directory_spec.rb
 - lib/dotsync/errors.rb
 - lib/dotsync/icons.rb
 - lib/dotsync/models/diff.rb