dotsync 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 77b4b56e47651cc2c8ab828bb4c77db6d1e8e5e58fb36df1e00f2a2a30ded2e3
-  data.tar.gz: f0c445bb9a6436a3e0058e589fe0373015a41e1013109272b06b0d948bd1dc6c
+  metadata.gz: '08b051bb2f245604662fd3f8347c70152dffb43d243d96bef919c38433a53124'
+  data.tar.gz: 79c2af0084417ad7c8253deac085b0466bbfd5d3c7b0c20054e92899907921b9
 SHA512:
-  metadata.gz: 73551d747d9687c969df56906d18354c133d1f947066fd3a2de3404512152a6f8fe07a6a0404556389da9702777615e4cf1b75b231f1cc3b14d84e6cceef5acd
-  data.tar.gz: 3bf4d314b25b8dfcc045c3dcf7a050ca09c33341acf6978717b218a43ca394b8fd416d1437e9b0ed7c27b304c65cbf2b8621482cf948683fe808dcd8282847f8
+  metadata.gz: 21107170e600b1649aebdf5c5b4a2b4750c796c6800684a3a9bf3bf32eac88c6ea3a55056c7bab5a910b4a244aa95bae56627d222f56756f376704992a3bbdd7
+  data.tar.gz: 4b920346a4a3dd410e35374678a957517a53d3dbcbe4fff737c7a0e88040c842e0a526728d923bd471b85c5660a5505ea0eeb4e5fe7dd22734b45e7b4c6d1d63

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

@@ -30,6 +30,7 @@ jobs:
           bundle exec rake
 
       - name: Publish to RubyGems
+        if: matrix.ruby == '3.2'
         run: |
           mkdir -p $HOME/.gem
           touch $HOME/.gem/credentials

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

@@ -21,3 +21,25 @@ jobs:
         GEM_HOST_API_KEY: "Bearer ${{secrets.GITHUB_TOKEN}}"
         OWNER: ${{ github.repository_owner }}
 
+  publish:
+    needs: test
+    runs-on: ubuntu-latest
+    if: github.ref == 'refs/heads/master' && matrix.ruby == '3.2'
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.2
+          bundler-cache: true
+
+      - name: Check if gem version has changed
+        id: gem_version_check
+        run: |
+          gem build *.gemspec
+          gem_name=$(ls *.gem | head -n 1)
+          gem info $gem_name --remote || echo "new_version" > version_changed
+        env:
+          GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+# 0.1.2
+
+Add gem version on usage banner
+
+# 0.1.1
+
+Add gem executables
+
 # 0.1.0
 
 Initial version

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dotsync (0.1.0)
+    dotsync (0.1.2)
       fileutils (~> 1.7.3)
       listen (~> 3.9.0)
       logger (~> 1.7.0)

data/README.md

@@ -1,8 +1,8 @@
 # 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.
+[![Ruby Gem Test Status](https://github.com/dsaenztagarro/dotsync/actions/workflows/gem-push.yml/badge.svg)](https://github.com/dsaenztagarro/dotsync/actions)
 
-TODO: Delete this and the text above, and describe your gem
+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.
 
 ## Installation
 
@@ -14,7 +14,7 @@ gem 'dotsync'
 
 And then execute:
 
-    $ bundle
+    $ bundle install
 
 Or install it yourself as:
 
@@ -22,9 +22,35 @@ Or install it yourself as:
 
 ## Usage
 
+### Executable Commands
+
+Dotsync provides the following commands to manage your dotfiles:
+
+- **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
+  ```
+
+  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.
+
+- **Watch**: Continuously monitor and sync changes between your local machine and the repository.
+  ```shell
+  dotsync watch
+  ```
+
+- **Setup**: Generate a default configuration file at `~/.config/dotsync.toml` with example mappings for `pull`, `push`, and `watch`.
+  ```shell
+  dotsync setup
+  ```
+
 ### Configuration
 
-The configuration file now uses a single `mappings` structure where `src` can represent both files and folders. Here is an example configuration file:
+The configuration file uses a `mappings` structure to define the source and destination of your dotfiles. Here is an example:
 
 ```toml
 [pull]
@@ -36,46 +62,29 @@ mappings = [
 [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" }
+  { src = "$XDG_CONFIG_HOME/alacritty", dest = "$DOTFILES_DIR/config/alacritty" }
 ]
 
 [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/'
+mappings = [
+  { src = "$HOME/.zshenv", dest = "$DOTFILES_DIR/home/.zshenv" },
+  { src = "$XDG_CONFIG_HOME/alacritty", dest = "$DOTFILES_DIR/config/alacritty" }
 ]
 ```
 
-### Synchronization
+### Pro Tips
 
-To sync your configuration files, use the following commands:
-
-- **Push**: Transfer dotfiles from your local machine to the destination repository.
+- **Using rbenv**: To ensure the gem uses the correct Ruby version managed by rbenv, you can run:
   ```shell
-  dotsync push
+  RBENV_VERSION=3.2.0 dotsync push
   ```
 
-- **Pull**: Synchronize dotfiles from the repository to your local machine.
+- **Global Installation**: Install the gem using a globally available Ruby version to make the executable accessible anywhere:
   ```shell
-  dotsync pull
+  gem install dotsync
   ```
 
-### Development
+## 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.
 
@@ -91,8 +100,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## 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`
+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/dsaenztagarro/dotsync/blob/master/CODE_OF_CONDUCT.md).

data/RELEASING.md

@@ -0,0 +1,8 @@
+## Check list for releasing a new version
+
+- [ ] From the root of your gem project, build the gem using `gem build`. This will create a `.gem` file.
+- [ ] Install the gem locally using `gem install ./your-gem-name-version.gem`. This will install the gem, including its executable.
+- [ ] After installation, the executable should be available globally in your shell path.
+- [ ] To ensure the proper Ruby version is used, confirm that your environment is set up with the correct Ruby version (e.g., using a Ruby version manager like rbenv or rvm).
+- [ ] From any location, you can now run the executable by typing its name (e.g., `dotsync`) to verify it works as expected.
+

data/exe/dotsync

@@ -0,0 +1,47 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/dotsync'
+require 'optparse'
+
+options = {}
+
+opt_parser = OptionParser.new do |opts|
+  opts.banner = <<~BANNER
+    dotsync #{Dotsync::VERSION}
+    Usage: dotsync [command] [options]
+
+    Commands:
+      push   Upload local changes to the remote
+      pull   Download remote changes to the local
+      watch  Continuously monitor and sync changes
+      setup  Initialize a default configuration file
+  BANNER
+
+  opts.on("-h", "--help", "Show this help message") do
+    puts opts
+    exit
+  end
+end
+
+opt_parser.parse!
+
+command = ARGV.shift
+
+case command
+when "push"
+  Dotsync::Runner.new.run(:push)
+when "pull"
+  Dotsync::Runner.new.run(:pull)
+when "watch"
+  Dotsync::Runner.new.run(:watch)
+when "setup"
+  Dotsync::Runner.new.run(:setup)
+else
+  if command
+    puts "dotsync: no such command '#{command}'"
+  else
+    puts opt_parser.banner
+  end
+  exit 1
+end
+

data/lib/dotsync/runner.rb

@@ -6,28 +6,65 @@ module Dotsync
 
     # action_name should be a symbol, e.g., :pull, :watch, :sync
     def run(action_name)
-      begin
-        action_class = Dotsync.const_get("#{camelize(action_name.to_s)}Action")
-        config_class = Dotsync.const_get("#{camelize(action_name.to_s)}ActionConfig")
-
-        config = config_class.new(Dotsync.config_path)
-        action = action_class.new(config, @logger)
-        action.execute
-      rescue ConfigError => e
-        @logger.error("[#{action_name}] config error:")
-        @logger.info(e.message)
-      rescue NameError => e
-        @logger.error("Unknown action '#{action_name}':")
-        @logger.info(e.message)
-      rescue => e
-        @logger.error("Error running '#{action_name}':")
-        @logger.info(e.message)
-        raise
+      case action_name
+      when :setup
+        setup_config
+      else
+        begin
+          action_class = Dotsync.const_get("#{camelize(action_name.to_s)}Action")
+          config_class = Dotsync.const_get("#{camelize(action_name.to_s)}ActionConfig")
+
+          config = config_class.new(Dotsync.config_path)
+          action = action_class.new(config, @logger)
+          action.execute
+        rescue ConfigError => e
+          @logger.error("[#{action_name}] config error:")
+          @logger.info(e.message)
+        rescue NameError => e
+          @logger.error("Unknown action '#{action_name}':")
+          @logger.info(e.message)
+        rescue => e
+          @logger.error("Error running '#{action_name}':")
+          @logger.info(e.message)
+          raise
+        end
       end
     end
 
     private
 
+    def setup_config
+      require 'toml-rb'
+      require 'fileutils'
+
+      config_path = File.expand_path(Dotsync.config_path)
+      FileUtils.mkdir_p(File.dirname(config_path))
+
+      example_mappings = {
+        "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" }
+          ]
+        }
+      }
+
+      File.write(config_path, TomlRB.dump(example_mappings))
+      @logger.info("Configuration file created at #{config_path}")
+    end
+
     # Utility to convert 'pull' to 'Pull', 'sync' to 'Sync', etc.
     def camelize(str)
       str.split('_').map(&:capitalize).join

data/lib/dotsync/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dotsync
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - David Sáenz
@@ -153,7 +153,10 @@ dependencies:
 description: Keep in sync your dotfiles across machines with a single TOML file
 email:
 - david.saenz.tagarro@gmail.com
-executables: []
+executables:
+- console
+- dotsync
+- setup
 extensions: []
 extra_rdoc_files: []
 files:
@@ -168,10 +171,12 @@ files:
 - Gemfile.lock
 - LICENSE.txt
 - README.md
+- RELEASING.md
 - Rakefile
-- bin/console
-- bin/setup
 - dotsync.gemspec
+- exe/console
+- exe/dotsync
+- exe/setup
 - lib/dotsync.rb
 - lib/dotsync/actions/base_action.rb
 - lib/dotsync/actions/config/base_config.rb
@@ -212,7 +217,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: Manage dotfiles like a boss