dotsync 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 77b4b56e47651cc2c8ab828bb4c77db6d1e8e5e58fb36df1e00f2a2a30ded2e3
+  data.tar.gz: f0c445bb9a6436a3e0058e589fe0373015a41e1013109272b06b0d948bd1dc6c
+SHA512:
+  metadata.gz: 73551d747d9687c969df56906d18354c133d1f947066fd3a2de3404512152a6f8fe07a6a0404556389da9702777615e4cf1b75b231f1cc3b14d84e6cceef5acd
+  data.tar.gz: 3bf4d314b25b8dfcc045c3dcf7a050ca09c33341acf6978717b218a43ca394b8fd416d1437e9b0ed7c27b304c65cbf2b8621482cf948683fe808dcd8282847f8

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

@@ -0,0 +1,41 @@
+name: Ruby Gem
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby: [3.2, 3.3]
+
+    name: Ruby ${{ matrix.ruby }} tests
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - name: Run tests
+        run: |
+          bundle exec rake
+
+      - name: Publish to RubyGems
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+          gem build *.gemspec
+          gem push *.gem
+        env:
+          GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

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

@@ -0,0 +1,23 @@
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Publish to GPR
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:github: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} *.gem
+      env:
+        GEM_HOST_API_KEY: "Bearer ${{secrets.GITHUB_TOKEN}}"
+        OWNER: ${{ github.repository_owner }}
+

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+3.4.1

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 0.1.0
+
+Initial version

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at dsaenz@bebanjo.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+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

@@ -0,0 +1,113 @@
+PATH
+  remote: .
+  specs:
+    dotsync (0.1.0)
+      fileutils (~> 1.7.3)
+      listen (~> 3.9.0)
+      logger (~> 1.7.0)
+      ostruct (~> 0.6.3)
+      toml-rb (~> 4.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.3)
+    citrus (3.0.2)
+    diff-lcs (1.6.2)
+    ffi (1.17.2)
+    ffi (1.17.2-aarch64-linux-gnu)
+    ffi (1.17.2-aarch64-linux-musl)
+    ffi (1.17.2-arm-linux-gnu)
+    ffi (1.17.2-arm-linux-musl)
+    ffi (1.17.2-arm64-darwin)
+    ffi (1.17.2-x86-linux-gnu)
+    ffi (1.17.2-x86-linux-musl)
+    ffi (1.17.2-x86_64-darwin)
+    ffi (1.17.2-x86_64-linux-gnu)
+    ffi (1.17.2-x86_64-linux-musl)
+    fileutils (1.7.3)
+    json (2.15.0)
+    language_server-protocol (3.17.0.5)
+    lint_roller (1.1.0)
+    listen (3.9.0)
+      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)
+      racc
+    prism (1.5.1)
+    racc (1.8.1)
+    rainbow (3.1.1)
+    rake (13.3.0)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.11.1)
+      ffi (~> 1.0)
+    rbs (3.9.5)
+      logger
+    regexp_parser (2.11.3)
+    rspec (3.13.1)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.5)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.6)
+    rubocop (1.81.1)
+      json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.47.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.47.1)
+      parser (>= 3.3.7.2)
+      prism (~> 1.4)
+    ruby-lsp (0.26.1)
+      language_server-protocol (~> 3.17.0)
+      prism (>= 1.2, < 2.0)
+      rbs (>= 3, < 5)
+    ruby-progressbar (1.13.0)
+    timecop (0.9.10)
+    toml-rb (4.0.0)
+      citrus (~> 3.0, > 3.0)
+      racc (~> 1.7)
+    unicode-display_width (3.2.0)
+      unicode-emoji (~> 4.1)
+    unicode-emoji (4.1.0)
+
+PLATFORMS
+  aarch64-linux-gnu
+  aarch64-linux-musl
+  arm-linux-gnu
+  arm-linux-musl
+  arm64-darwin
+  ruby
+  x86-linux-gnu
+  x86-linux-musl
+  x86_64-darwin
+  x86_64-linux-gnu
+  x86_64-linux-musl
+
+DEPENDENCIES
+  dotsync!
+  rake (~> 13.3.0)
+  rspec (~> 3.13.1)
+  rubocop (~> 1.81.1)
+  ruby-lsp (~> 0.26.1)
+  timecop (~> 0.9.10)
+
+BUNDLED WITH
+   2.7.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 David Sáenz
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,98 @@
+# Dotsync
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/dotsync`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dotsync'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dotsync
+
+## Usage
+
+### Configuration
+
+The configuration file now uses a single `mappings` structure where `src` can represent both files and folders. Here is an example configuration file:
+
+```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" },
+  { src = "$XDG_CONFIG_HOME/brewfile", dest = "$DOTFILES_DIR/config/brewfile" },
+  { src = "$XDG_CONFIG_HOME/exercism", dest = "$DOTFILES_DIR/config/exercism" },
+  { src = "$XDG_CONFIG_HOME/git", dest = "$DOTFILES_DIR/config/git" },
+  { src = "$XDG_CONFIG_HOME/nvim", dest = "$DOTFILES_DIR/config/nvim", ignore = "lazy-lock.json" },
+  { src = "$XDG_CONFIG_HOME/zellij", dest = "$DOTFILES_DIR/config/zellij" },
+  { src = "$XDG_CONFIG_HOME/zsh", dest = "$DOTFILES_DIR/config/zsh", ignore = [".zsh_sessions", ".zsh_history"] },
+  { src = "$XDG_CONFIG_HOME/starship.toml", dest = "$DOTFILES_DIR/config/starship.toml" },
+  { src = "$XDG_CONFIG_HOME/dotsync.toml", dest = "$DOTFILES_DIR/dotsync/macmini.toml" }
+]
+
+[watch]
+src = '~/.config'
+dest = '~/Code/dotfiles/src/'
+paths = [
+  '~/.config/alacritty/',
+  '~/.config/zellij/',
+  '~/.config/nvim/',
+  '~/.config/exercism/',
+  '~/.config/nvim/init.lua',
+  '~/.config/nvim/lua/',
+  '~/.config/nvim/after/'
+]
+```
+
+### Synchronization
+
+To sync your configuration files, use the following commands:
+
+- **Push**: Transfer dotfiles from your local machine to the destination repository.
+  ```shell
+  dotsync push
+  ```
+
+- **Pull**: Synchronize dotfiles from the repository to your local machine.
+  ```shell
+  dotsync pull
+  ```
+
+### 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.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/dsaenztagarro/dotsync. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Dotsync project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/dotsync/blob/master/CODE_OF_CONDUCT.md).
+
+## Rake tasks
+
+List with `bundle exec rake -AT`

data/Rakefile

@@ -0,0 +1,53 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+require 'dotsync'
+
+# Load all tasks
+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'
+end
+
+task default: :spec
+
+desc "hello task"
+task :hello do
+  puts "hello world"
+end
+
+namespace :dotsync do
+  desc "Pull Dotfiles"
+  task :pull do
+    Dotsync::Runner.new.run(:pull)
+  end
+
+  desc "Push Dotfiles"
+  task :push do
+    Dotsync::Runner.new.run(:push)
+  end
+
+  desc "Watch Dotfiles"
+  task :watch do
+    Dotsync::Runner.new.run(:watch)
+  end
+end
+
+namespace :palette do
+  desc "Show palette background"
+  task :bg do
+    (0..255).each do |color|
+      print "\e[48;5;#{color}m #{color.to_s.rjust(3)} \e[0m"
+      puts if (color + 1) % 16 == 0
+    end
+  end
+
+  desc "Show palette foreground"
+  task :fg do
+    (0..255).each do |color|
+      print "\e[38;5;#{color}m\e[1m #{color.to_s.rjust(3)} \e[0m"
+      puts if (color + 1) % 16 == 0
+    end
+  end
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "dotsync"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/dotsync.gemspec

@@ -0,0 +1,38 @@
+require_relative "lib/dotsync/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "dotsync"
+  spec.version       = Dotsync::VERSION
+  spec.authors       = ["David Sáenz"]
+  spec.email         = ["david.saenz.tagarro@gmail.com"]
+
+  spec.summary       = "Manage dotfiles like a boss"
+  spec.description   = "Keep in sync your dotfiles across machines with a single TOML file"
+  spec.homepage      = "https://github.com/dsaenztagarro/dotsync"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 3.2.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/dsaenztagarro/dotsync"
+  spec.metadata["changelog_uri"] = "https://github.com/dsaenztagarro/dotsync/blob/master/CHANGELOG.md"
+
+  # 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
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "toml-rb", "~> 4.0.0"
+  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"
+  spec.add_development_dependency "timecop", "~> 0.9.10"
+  spec.add_development_dependency "ruby-lsp", "~> 0.26.1"
+end

data/lib/dotsync/actions/base_action.rb

@@ -0,0 +1,43 @@
+module Dotsync
+  class BaseAction
+    include Dotsync::PathUtils
+
+    extend Forwardable # def_delegator
+
+    attr_reader :logger
+    def_delegator :logger, :info
+    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/config/base_config.rb

@@ -0,0 +1,68 @@
+module Dotsync
+  # BaseConfig serves as an abstract class to define the structure
+  # and validation rules for configuration files in the Dotsync system.
+  class BaseConfig
+    include Dotsync::PathUtils
+
+    # Initialize the BaseConfig with the provided path.
+    # Loads the TOML configuration file and validates it.
+    #
+    # @param [String] path The file path to the configuration file.
+    def initialize(path = Dotsync.config_path)
+      absolute_path = File.expand_path(path)
+      @config = TomlRB.load_file(absolute_path)
+      validate!
+    end
+
+    private
+
+      # Validates the configuration file.
+      #
+      # @raise [NotImplementedError] if not implemented by a subclass.
+      def validate!
+        raise NotImplementedError
+      end
+
+      # Returns the name of the section to validate.
+      #
+      # @return [String] The section name.
+      # @raise [NotImplementedError] if not implemented by a subclass.
+      def section_name
+        raise NotImplementedError
+      end
+
+      # Retrieves the configuration section.
+      #
+      # @return [Hash] The section of the configuration file.
+      def section
+        @config[section_name]
+      end
+
+      # Validates if the required section is present in the configuration.
+      #
+      # @raise [Dotsync::ConfigError] if the section is missing.
+      def validate_section_present!
+        unless @config.key?(section_name)
+          raise_error "No [#{section_name}] section found in config file"
+        end
+      end
+
+      # Validates if a specific key is present in the section.
+      #
+      # @param [String] key The key to validate.
+      # @raise [Dotsync::ConfigError] if the key is missing.
+      def validate_key_present!(key)
+        unless section.key?(key)
+          raise_error "[#{section_name}] section does not include key '#{key}'"
+        end
+      end
+
+      # Raises a configuration error with the provided message.
+      #
+      # @param [String] message The error message to raise.
+      # @raise [Dotsync::ConfigError] Always raises this error with the given message.
+      def raise_error(message)
+        raise Dotsync::ConfigError, "Config Error: #{message}"
+      end
+  end
+end