dotsync 0.1.15 → 0.1.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c1bdf9f9ccaf7c8fb89e69d1e2f8cd95b72bc7b089d2e582fb358a84ebefb6d2
-  data.tar.gz: e05942884ce70c0921c8bfa18f7a9e8be1d8f92ff06912b1f9d09098088ff8fc
+  metadata.gz: 653f18b457e91c025888eb6fca1d14de2718aa0ee7253c30d80e699c6fdc720a
+  data.tar.gz: 9c180933f5b35c186fbfaf754a38a9217fcdd459fae3c75d67787d43516f3871
 SHA512:
-  metadata.gz: f33b7f4c6293a0a50c263560f433f7712f6b7d67f997222db3070c7c72b35837b7ed7d92c1b7fcc3b05574d047db6d4daa8a97bd20438e1237ed9f1ffbd8fba8
-  data.tar.gz: 15e81bab5c0eaba1ab206c7a8c720f1baaacceb1e8ee5429e7ec1df20515329466c1a43949a637a8485219d92578d2e6acefc3768a529aef9136b90ab6d6b34a
+  metadata.gz: 0aedae57228a61723b3f4f929e64387dce6fbc227d2f9d68271512eafa7ff15c7ac780fc0f2be80b60868266f309d52403b0ea24d7222770f5ce16edce102df9
+  data.tar.gz: 19cb8d65ba7216aa1e2577eb77876a363267e1f7a73f5b5c7dd9ce26c4490988613d30be2199e1580971ac10c45515f86d145bd6565b98edd6d0035dacd352c5

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

@@ -44,3 +44,8 @@ jobs:
           gem push *.gem
         env:
           GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"
+
+      - name: Generate release tag
+        if: matrix.ruby == '3.2' && github.ref_name == 'master'
+        run: |
+          bundle exec rake release:tag

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+# 0.1.16
+
+- DirectoryDiffer: fixes path on removal difference
+- MappingsTransfer: fixes "Differences" label text for clarity
+- Add Difference Legend
+- Show Difference Legend only if there are any difference
+- OutputSections: added new options to hide output
+
 # 0.1.15
 
 - Readme: update screenshots in docs

data/Gemfile.lock

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

data/README.md

@@ -35,15 +35,37 @@ Dotsync provides the following commands to manage your dotfiles:
 
 - **Push**: Transfer dotfiles from your local machine to the destination repository.
   ```shell
-  dotsync push --apply
+  dotsync push --apply [OPTION]
   ```
+  Options:
+    - `-q, --quiet`: Hide all non-essential output (only errors or final status).
+    - `--no-legend`: Hide all legends for config, mappings, and differences.
+    - `--no-config`: Hide the config section in the output.
+    - `--no-mappings`: Hide the mappings and their legend.
+    - `--no-diff-legend`: Hide the differences legend only.
+    - `--no-diff`: Hide the differences section itself.
+    - `--only-diff`: Show only the differences section.
+    - `--only-config`: Show only the config section.
+    - `--only-mappings`: Show only the mappings section.
+    - `-v, --verbose`: Force showing all available information.
 
   ![dotsync push](docs/images/dotsync_push.png)
 
 - **Pull**: Synchronize dotfiles from the repository to your local machine.
   ```shell
-  dotsync pull --apply
+  dotsync pull --apply [OPTION]
   ```
+  Options:
+    - `-q, --quiet`: Hide all non-essential output (only errors or final status).
+    - `--no-legend`: Hide all legends for config, mappings, and differences.
+    - `--no-config`: Hide the config section in the output.
+    - `--no-mappings`: Hide the mappings and their legend.
+    - `--no-diff-legend`: Hide the differences legend only.
+    - `--no-diff`: Hide the differences section itself.
+    - `--only-diff`: Show only the differences section.
+    - `--only-config`: Show only the config section.
+    - `--only-mappings`: Show only the mappings section.
+    - `-v, --verbose`: Force showing all available information.
 
   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.
 
@@ -165,9 +187,14 @@ When running `push` or `pull` actions, the mappings are rendered in the console
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+- After checking out the repo, run `bin/setup` to install dependencies.
+- Then, run `rake spec` to run the tests.
+- You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+- To install this gem onto your local machine, run `bundle exec rake install`.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+### Releasing a new version
+- Update the version number in `version.rb`.
+- Run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 

data/Rakefile

@@ -14,11 +14,28 @@ end
 
 task default: :spec
 
-desc "hello task"
-task :hello do
-  puts "hello world"
+namespace :release do
+  desc "Tag git with the current Dotsync::VERSION"
+  task :tag do
+    require_relative "./lib/dotsync/version"
+    version = Dotsync::VERSION
+    tag_name = "v#{version}"
+
+    # Check if tag already exists
+    if `git tag --list`.split.include?(tag_name)
+      puts "Tag #{tag_name} already exists."
+      exit(1)
+    end
+
+    puts "Tagging commit as #{tag_name}..."
+    sh "git tag -a #{tag_name} -m 'Release #{tag_name}'"
+    puts "Pushing tag #{tag_name} to origin..."
+    sh "git push origin #{tag_name}"
+    puts "Done!"
+  end
 end
 
+
 namespace :dotsync do
   desc "Pull Dotfiles"
   task :pull do

data/exe/dotsync

@@ -18,12 +18,58 @@ opt_parser = OptionParser.new do |opts|
       setup  Initialize a default configuration file
 
     Options:
-      -a, --apply   Apply changes (push or pull)
-      -h, --help    Show this help message
+      -a, --apply           Apply changes (push or pull)
+      -q, --quiet           Hide all non-essential output (only errors or final status)
+      --no-legend           Hide all legends for config, mappings, and differences
+      --no-config           Hide the config section in the output
+      --no-mappings         Hide the mappings and their legend
+      --no-diff-legend      Hide the differences legend only
+      --no-diff             Hide the differences section itself
+      --only-diff           Show only the differences section
+      --only-config         Show only the config section
+      --only-mappings       Show only the mappings section
+      -v, --verbose         Force showing all available information
+      -h, --help            Show this help message
   BANNER
 
-  opts.on("-a", "--apply", "Apply changes (push or pull)") do
-    options[:apply] = true
+  opts.on("-q", "--quiet", "Hide all non-essential output (only errors or final status)") do
+    options[:quiet] = true
+  end
+
+  opts.on("--no-legend", "Hide all legends for config, mappings, and differences") do
+    options[:no_legend] = true
+  end
+
+  opts.on("--no-config", "Hide the config section in the output") do
+    options[:no_config] = true
+  end
+
+  opts.on("--no-mappings", "Hide the mappings and their legend") do
+    options[:no_mappings] = true
+  end
+
+  opts.on("--no-diff-legend", "Hide the differences legend only") do
+    options[:no_diff_legend] = true
+  end
+
+  opts.on("--no-diff", "Hide the differences section itself") do
+    options[:no_diff] = true
+  end
+
+  opts.on("--only-diff", "Show only the differences section") do
+    options[:only_diff] = true
+  end
+
+  opts.on("--only-config", "Show only the config section") do
+    options[:only_config] = true
+  end
+
+  opts.on("--only-mappings", "Show only the mappings section") do
+    options[:only_mappings] = true
+  end
+
+  opts.on("-v", "--verbose", "Force showing all available information") do
+    options[:verbose] = true
   end
 
   opts.on("-h", "--help", "Show this help message") do

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

@@ -4,11 +4,17 @@ 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"]
+    MAPPINGS_LEGEND = [
+      [Icons.force, "The source will overwrite the destination"],
+      [Icons.only, "Paths designated explicitly as source only"],
+      [Icons.ignore, "Paths configured to be ignored in the destination"],
+      [Icons.invalid, "Invalid paths detected in the source or destination"]
+    ]
+
+    DIFFERENCES_LEGEND = [
+      [Icons.diff_created, "Created/added file"],
+      [Icons.diff_updated, "Updated/modified file"],
+      [Icons.diff_removed, "Removed/deleted file"]
     ]
 
     extend Forwardable # def_delegator
@@ -28,8 +34,8 @@ module Dotsync
     end
 
     def show_mappings_legend
-      info("Legend:", icon: :legend)
-      table = Terminal::Table.new(rows: LEGEND)
+      info("Mappings Legend:", icon: :legend)
+      table = Terminal::Table.new(rows: MAPPINGS_LEGEND)
       logger.log(table)
       logger.log("")
     end
@@ -49,25 +55,26 @@ module Dotsync
       logger.log("")
     end
 
-    def show_changes
-      diffs = valid_mappings.map do |mapping|
-        Dotsync::DirectoryDiffer.new(mapping).diff
-      end
-      has_diff = false
-      info("Diff:", icon: :diff)
-      diffs.flat_map(&:additions).sort.each do |path|
-        logger.log("  #{path}", color: Dotsync::Colors.diff_additions)
-        has_diff = true
+    def show_differences_legend
+      info("Differences Legend:", icon: :legend)
+      table = Terminal::Table.new(rows: DIFFERENCES_LEGEND)
+      logger.log(table)
+      logger.log("")
+    end
+
+    def show_differences
+      info("Differences:", icon: :diff)
+      differs.flat_map(&:additions).sort.each do |path|
+        logger.log("#{Icons.diff_created}#{path}", color: Colors.diff_additions)
       end
-      diffs.flat_map(&:modifications).sort.each do |path|
-        logger.log("  #{path}", color: Dotsync::Colors.diff_modifications)
-        has_diff = true
+      differs.flat_map(&:modifications).sort.each do |path|
+        logger.log("#{Icons.diff_updated}#{path}", color: Colors.diff_modifications)
       end
-      diffs.flat_map(&:removals).sort.each do |path|
-        logger.log("  #{path}", color: Dotsync::Colors.diff_removals)
-        has_diff = true
+      differs.flat_map(&:removals).sort.each do |path|
+        logger.log("#{Icons.diff_removed}#{path}", color: Colors.diff_removals)
       end
-      logger.log("  No differences") unless has_diff
+      logger.log("  No differences") unless has_differences?
+      logger.log("")
     end
 
     def transfer_mappings
@@ -77,6 +84,16 @@ module Dotsync
     end
 
     private
+      def differs
+        @differs ||= valid_mappings.map do |mapping|
+          Dotsync::DirectoryDiffer.new(mapping).diff
+        end
+      end
+
+      def has_differences?
+        differs.any? { |differ| differ.any? }
+      end
+
       def mappings_env_vars
         paths = mappings.flat_map do |mapping|
           [mapping.original_src, mapping.original_dest]

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Dotsync
+  module OutputSections
+    def compute_output_sections(options)
+      quiet = options[:quiet]
+      verbose = options[:verbose]
+
+      output_sections = {
+        options: !(quiet || options[:only_diff] || options[:only_mappings]),
+        env_vars: !(quiet || options[:only_diff] || options[:only_mappings]),
+        mappings_legend: !(quiet || options[:no_legend] || options[:no_mappings] || options[:only_diff]),
+        mappings: !(quiet || options[:no_mappings] || options[:only_diff]),
+        differences_legend: !(quiet || options[:no_legend] || options[:no_diff_legend] || options[:no_diff] || options[:only_config]),
+        differences: !(quiet || options[:no_diff] || options[:only_mappings] || options[:only_config])
+      }
+
+      if verbose
+        output_sections.transform_values! { |_| true }
+      end
+
+      output_sections
+    end
+  end
+end

data/lib/dotsync/actions/pull_action.rb

@@ -3,15 +3,20 @@
 module Dotsync
   class PullAction < BaseAction
     include MappingsTransfer
+    include OutputSections
 
     def_delegator :@config, :backups_root
 
     def execute(options = {})
-      show_options(options)
-      show_env_vars
-      show_mappings_legend
-      show_mappings
-      show_changes
+      output_sections = compute_output_sections(options)
+
+      show_options(options) if output_sections[:options]
+      show_env_vars if output_sections[:env_vars]
+      show_mappings_legend if output_sections[:mappings_legend]
+      show_mappings if output_sections[:mappings]
+      show_differences_legend if has_differences? && output_sections[:differences_legend]
+      show_differences if output_sections[:differences]
+
       return unless options[:apply]
 
       if create_backup

data/lib/dotsync/actions/push_action.rb

@@ -3,13 +3,18 @@
 module Dotsync
   class PushAction < BaseAction
     include MappingsTransfer
+    include OutputSections
 
     def execute(options = {})
-      show_options(options)
-      show_env_vars
-      show_mappings_legend
-      show_mappings
-      show_changes
+      output_sections = compute_output_sections(options)
+
+      show_options(options) if output_sections[:options]
+      show_env_vars if output_sections[:env_vars]
+      show_mappings_legend if output_sections[:mappings_legend]
+      show_mappings if output_sections[:mappings]
+      show_differences_legend if has_differences? && output_sections[:differences_legend]
+      show_differences if output_sections[:differences]
+
       return unless options[:apply]
 
       transfer_mappings

data/lib/dotsync/icons.rb

@@ -13,12 +13,17 @@ module Dotsync
     CONFIG = " "
     DIFF = " "
 
-    # Default Mapping Flags icons
+    # Default Mappings Legend icons
     DEFAULT_FORCE = "󰁪 "
     DEFAULT_ONLY = " "
     DEFAULT_IGNORE = "󰈉 "
     DEFAULT_INVALID = "󱏏 "
 
+    # Default Mappings Differences icons
+    DEFAULT_DIFF_CREATED = " "
+    DEFAULT_DIFF_UPDATED = " "
+    DEFAULT_DIFF_REMOVED = " "
+
     # Action icons
     PULL = " "
     PUSH = " "
@@ -39,13 +44,20 @@ module Dotsync
 
     def self.load_custom_icons(config)
       @custom_icons = {
+        # Mappings Legend
         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
+        invalid: config.dig("icons", "invalid") || DEFAULT_INVALID,
+        # Differences Legend
+        diff_created: config.dig("icons", "diff_created") || DEFAULT_DIFF_CREATED,
+        diff_updated: config.dig("icons", "diff_updated") || DEFAULT_DIFF_UPDATED,
+        diff_removed: config.dig("icons", "diff_removed") || DEFAULT_DIFF_REMOVED,
       }
     end
 
+    # Mappings Legend methods
+
     def self.force
       @custom_icons[:force] || DEFAULT_FORCE
     end
@@ -62,6 +74,20 @@ module Dotsync
       @custom_icons[:invalid] || DEFAULT_INVALID
     end
 
+    # Differences Legend methods
+
+    def self.diff_created
+      @custom_icons[:diff_created] || DEFAULT_DIFF_CREATED
+    end
+
+    def self.diff_updated
+      @custom_icons[:diff_updated] || DEFAULT_DIFF_UPDATED
+    end
+
+    def self.diff_removed
+      @custom_icons[:diff_removed] || DEFAULT_DIFF_REMOVED
+    end
+
     # https://www.nerdfonts.com
     MAPPINGS = {
       info: INFO,

data/lib/dotsync/models/diff.rb

@@ -11,6 +11,10 @@ module Dotsync
       @removals = removals
     end
 
+    def any?
+      @additions.any? || @modifications.any? || @removals.any?
+    end
+
     def empty?
       @additions.empty? && @modifications.empty? && @removals.empty?
     end

data/lib/dotsync/utils/directory_differ.rb

@@ -67,7 +67,7 @@ module Dotsync
 
         additions = relative_to_absolute(filter_ignores(additions), mapping_original_dest)
         modifications = relative_to_absolute(filter_ignores(modifications), mapping_original_dest)
-        removals = relative_to_absolute(filter_ignores(removals), mapping_original_src)
+        removals = relative_to_absolute(filter_ignores(removals), mapping_original_dest)
 
         Dotsync::Diff.new(additions: additions, modifications: modifications, removals: removals)
       end

data/lib/dotsync/version.rb

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

data/lib/dotsync.rb

@@ -38,6 +38,7 @@ require_relative "dotsync/config/watch_action_config"
 
 # Actions Concerns
 require_relative "dotsync/actions/concerns/mappings_transfer"
+require_relative "dotsync/actions/concerns/output_sections"
 
 # Actions
 require_relative "dotsync/actions/base_action"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dotsync
 version: !ruby/object:Gem::Version
-  version: 0.1.15
+  version: 0.1.16
 platform: ruby
 authors:
 - David Sáenz
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-11-07 00:00:00.000000000 Z
+date: 2025-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: toml-rb
@@ -252,9 +252,7 @@ description: Keep in sync your dotfiles across machines with a single TOML file
 email:
 - david.saenz.tagarro@gmail.com
 executables:
-- console
 - dotsync
-- setup
 extensions: []
 extra_rdoc_files: []
 files:
@@ -272,16 +270,17 @@ files:
 - README.md
 - RELEASING.md
 - Rakefile
+- bin/console
+- bin/setup
 - docs/images/dotsync_pull.png
 - docs/images/dotsync_push.png
 - docs/images/dotsync_push_apply.png
 - dotsync.gemspec
-- exe/console
 - exe/dotsync
-- exe/setup
 - lib/dotsync.rb
 - lib/dotsync/actions/base_action.rb
 - lib/dotsync/actions/concerns/mappings_transfer.rb
+- lib/dotsync/actions/concerns/output_sections.rb
 - lib/dotsync/actions/pull_action.rb
 - lib/dotsync/actions/push_action.rb
 - lib/dotsync/actions/watch_action.rb