change_agent 0.2.2 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: fbc730c2e2b77b9c74f11271068be748693ed7cc
-  data.tar.gz: 60235cb602da5ff45a4c81ea326360f1c034b7c5
+SHA256:
+  metadata.gz: b9e1bb76f1fdfc79b7c66cb1856b3c7ddc2ce7fc4e0d84b9c7209c8a01b85453
+  data.tar.gz: 69652cf94dc625148debbb9d7ad68bf763781a01d0c939eac6a9b695813f8614
 SHA512:
-  metadata.gz: 513344a2125c811e5c7c41d43fab6eddfb8f57e5558bf7b2174bdbdd1792a8113ccdbad000a29e31e7312f64d49f59169bafbe300f340c8bab4fc5c04ffe09b9
-  data.tar.gz: 4fe65ff532e478f88e084af7f482cb858104f885cf4e26336c8b8a7b3a14bf2458387bbc2efe4bf77200b3226890a6f4bfecc106e21c3d5f3f82e6facc18c2d6
+  metadata.gz: 94fbd390e06214dc7d6444873e27c24c75863b75ac10b1919f157e06356967388d9e4970d396d2a47433f10abec28d0b3017b31967804fbe69d49ee7e647f2c6
+  data.tar.gz: c79c86ba8a1f47b56a3caa42c5432c6d0914aee4a1584f8d88377d6fa1eb539da50ea5ee393d9244d741e6b6e971c6b7af831406f233591f10324a049514fb1e

data/.github/dependabot.yml

@@ -0,0 +1,11 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
+
+version: 2
+updates:
+  - package-ecosystem: "bundler" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"

data/.github/workflows/ci.yml

@@ -0,0 +1,21 @@
+name: CI
+
+on:
+  push:
+    branches: [ main, master ]
+  pull_request:
+    branches: [ main, master ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+          ruby-version: 3.2
+      - name: Run cibuild script
+        run: script/cibuild

data/.rubocop.yml

@@ -0,0 +1,5 @@
+inherit_from: .rubocop_todo.yml
+AllCops:
+  NewCops: enable
+plugins:
+  - rubocop-performance

data/.rubocop_todo.yml

@@ -0,0 +1,54 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2025-05-07 20:42:05 UTC using RuboCop version 1.75.5.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 6
+# Configuration parameters: EnforcedStyle, AllowedGems, Include.
+# SupportedStyles: Gemfile, gems.rb, gemspec
+# Include: **/*.gemspec, **/Gemfile, **/gems.rb
+Gemspec/DevelopmentDependencies:
+  Exclude:
+    - 'change_agent.gemspec'
+
+# Offense count: 1
+# Configuration parameters: Severity, Include.
+# Include: **/*.gemspec
+Gemspec/RequiredRubyVersion:
+  Exclude:
+    - 'change_agent.gemspec'
+
+# Offense count: 2
+# Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes.
+Metrics/AbcSize:
+  Max: 30
+
+# Offense count: 1
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
+Metrics/MethodLength:
+  Max: 15
+
+# Offense count: 1
+# Configuration parameters: NamePrefix, ForbiddenPrefixes, AllowedMethods, MethodDefinitionMacros, UseSorbetSigs.
+# NamePrefix: is_, has_, have_, does_
+# ForbiddenPrefixes: is_, has_, have_, does_
+# AllowedMethods: is_a?
+# MethodDefinitionMacros: define_method, define_singleton_method
+Naming/PredicateName:
+  Exclude:
+    - 'spec/**/*'
+    - 'lib/change_agent/sync.rb'
+
+# Offense count: 4
+# Configuration parameters: AllowedConstants.
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/change_agent.rb'
+    - 'lib/change_agent/client.rb'
+    - 'lib/change_agent/document.rb'
+    - 'lib/change_agent/sync.rb'

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in change_agent.gemspec

data/README.md

@@ -16,7 +16,7 @@ Want to see it in action? Check out [this lightweight demo](https://github.com/b
 
 ## Okay, I'm sold. How do I use it?
 
-ChangeAgent writes values to the file system based on a given key, and immediately commits the file to Git, providing you with both a snapshot and a timestamp for every change.
+ChangeAgent writes values directly to the Git database based on a given key (path), and immediately triggers a commit, providing you with both a snapshot and a timestamp for every change.
 
 ### Basic usage
 

data/Rakefile

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 require 'rake'
 require 'rake/testtask'
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 
 Rake::TestTask.new(:test) do |test|
   test.libs << 'lib' << 'test'
@@ -8,7 +10,7 @@ Rake::TestTask.new(:test) do |test|
   test.verbose = true
 end
 
-desc "Open console with Change Agent loaded"
+desc 'Open console with Change Agent loaded'
 task :console do
-  exec "pry -r ./lib/change_agent.rb"
+  exec 'pry -r ./lib/change_agent.rb'
 end

data/change_agent.gemspec

@@ -1,26 +1,29 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'change_agent/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "change_agent"
+  spec.name          = 'change_agent'
   spec.version       = ChangeAgent::VERSION
-  spec.authors       = ["Ben Balter"]
-  spec.email         = ["ben.balter@github.com"]
-  spec.summary       = "A Git-backed key-value store, for tracking changes to documents and other files over time."
-  spec.homepage      = "https://github.com/benbalter/change-agent"
-  spec.license       = "MIT"
+  spec.authors       = ['Ben Balter']
+  spec.email         = ['ben.balter@github.com']
+  spec.summary       = 'A Git-backed key-value store, for tracking changes to documents and other files over time.'
+  spec.homepage      = 'https://github.com/benbalter/change-agent'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_dependency "rugged", "~> 0.21"
-  spec.add_dependency "dotenv", "~> 1.0"
-  spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "rake", "~> 10.4"
-  spec.add_development_dependency "pry", "~> 0.10"
-  spec.add_development_dependency "shoulda", "~> 3.5"
+  spec.add_dependency 'dotenv', '>= 3.1', '< 4.0'
+  spec.add_dependency 'rugged', '>= 1.9', '< 2.0'
+  spec.add_development_dependency 'bundler', '>= 2.0', '< 3.0'
+  spec.add_development_dependency 'pry', '>= 0.15', '< 1.0'
+  spec.add_development_dependency 'rake', '>= 13.0', '< 14.0'
+  spec.add_development_dependency 'rubocop', '>= 1.0', '< 2.0'
+  spec.add_development_dependency 'rubocop-performance', '>= 1.0', '< 2.0'
+  spec.add_development_dependency 'shoulda', '>= 4.0', '< 5.0'
+  spec.metadata['rubygems_mfa_required'] = 'true'
 end

data/lib/change_agent/client.rb

@@ -1,26 +1,28 @@
+# frozen_string_literal: true
+
 module ChangeAgent
   class Client
-
     include ChangeAgent::Sync
     attr_accessor :directory
 
-    def initialize(directory=nil, remote=nil)
+    def initialize(directory = nil, remote = nil)
       @directory = File.expand_path(directory || Dir.pwd)
       @remote = remote
     end
 
     def repo
-      if @remote.nil?
-        @repo ||= Rugged::Repository.init_at directory
-      else
-        @repo ||= Rugged::Repository.clone_at @remote, directory, {:credentials => credentials}
-      end
+      @repo ||= if @remote.nil?
+                  Rugged::Repository.init_at directory
+                else
+                  Rugged::Repository.clone_at @remote, directory, { credentials: credentials }
+                end
     end
 
     def set(key, value)
       document = Document.new(key, self)
       document.contents = value
       return unless document.changed?
+
       document.save
       document
     end
@@ -40,6 +42,5 @@ module ChangeAgent
     def inspect
       "#<ChangeAgent::Client repo=\"#{directory}\">"
     end
-
   end
 end

data/lib/change_agent/document.rb

@@ -1,17 +1,18 @@
+# frozen_string_literal: true
+
 module ChangeAgent
   class Document
-
     attr_writer :contents
     attr_accessor :path
-    alias_method :key, :path
+    alias key path
 
-    def initialize(path, client_or_directory=nil)
+    def initialize(path, client_or_directory = nil)
       @path = path
-      if client_or_directory.class == ChangeAgent::Client
-        @client = client_or_directory
-      else
-        @client = ChangeAgent::Client.new(client_or_directory)
-      end
+      @client = if client_or_directory.instance_of?(ChangeAgent::Client)
+                  client_or_directory
+                else
+                  ChangeAgent::Client.new(client_or_directory)
+                end
     end
 
     def repo
@@ -28,24 +29,24 @@ module ChangeAgent
 
     def save
       oid = repo.write contents, :blob
-      repo.index.add(path: path, oid: oid, mode: 0100644)
+      repo.index.add(path: path, oid: oid, mode: 0o100644)
 
       Rugged::Commit.create repo,
-        message: "Updating #{path}",
-        parents: repo.empty? ? [] : [ repo.head.target ],
-        tree: repo.index.write_tree(repo),
-        update_ref: 'HEAD'
+                            message: "Updating #{path}",
+                            parents: repo.empty? ? [] : [repo.head.target],
+                            tree: repo.index.write_tree(repo),
+                            update_ref: 'HEAD'
     end
-    alias_method :write, :save
+    alias write save
 
-    def delete(file=path)
+    def delete(file = path)
       repo.index.remove(file)
 
       Rugged::Commit.create repo,
-        message: "Removing #{path}",
-        parents: [repo.head.target],
-        tree: repo.index.write_tree(repo),
-        update_ref: 'HEAD'
+                            message: "Removing #{path}",
+                            parents: [repo.head.target],
+                            tree: repo.index.write_tree(repo),
+                            update_ref: 'HEAD'
     rescue Rugged::IndexError
       false
     end
@@ -59,7 +60,7 @@ module ChangeAgent
     def blob_contents
       tree = repo.head.target.tree
       blob = repo.lookup tree.path(path)[:oid]
-      blob.content
+      blob.content.force_encoding('UTF-8')
     rescue Rugged::ReferenceError, Rugged::TreeError
       nil
     end

data/lib/change_agent/sync.rb

@@ -1,23 +1,24 @@
+# frozen_string_literal: true
+
 module ChangeAgent
   module Sync
-
     class MergeConflict < StandardError; end
     class MissingRemote < ArgumentError; end
 
     attr_writer :credentials
 
-    DEFAULT_REMOTE = "origin"
-    DEFAULT_REMOTE_BRANCH = "origin/master"
-    DEFAULT_LOCAL_REF = "refs/heads/master"
+    DEFAULT_REMOTE = 'origin'
+    DEFAULT_REMOTE_BRANCH = 'origin/master'
+    DEFAULT_LOCAL_REF = 'refs/heads/master'
 
     # Default to token-based credentials passed as GITHUB_TOKEN
     # Can be over ridden by overwritting @credentials with a
     # different Rugged Credentialing method
     def credentials
       @credentials ||= Rugged::Credentials::UserPassword.new({
-         :username => "x-oauth-basic",
-         :password => ENV["GITHUB_TOKEN"]
-      })
+                                                               username: 'x-oauth-basic',
+                                                               password: ENV.fetch('GITHUB_TOKEN', nil)
+                                                             })
     end
 
     # Helper method to return all remots
@@ -32,7 +33,7 @@ module ChangeAgent
 
     # Does the current repo have at least a single remote?
     def has_remotes?
-      remotes.count > 0
+      remotes.count.positive?
     end
 
     # Push to a remote
@@ -40,19 +41,22 @@ module ChangeAgent
     # Options:
     #  :remote - the name of the remote (default: origin)
     #  :ref    - the ref to push (default: "refs/heads/master")
-    def push(options={})
+    def push(options = {})
       raise MissingRemote unless has_remotes?
-      options.merge! :remote => DEFAULT_REMOTE, :ref => DEFAULT_LOCAL_REF
-      remotes[options[:remote]].push([options[:ref]], {:credentials => credentials})
+
+      options[:remote] = DEFAULT_REMOTE
+      options[:ref] = DEFAULT_LOCAL_REF
+      remotes[options[:remote]].push([options[:ref]], { credentials: credentials })
     end
 
     # Fetch a remote
     #
     # Options:
     #  remote - the name of the remote (default: origin)
-    def fetch(remote=nil)
+    def fetch(remote = nil)
       raise MissingRemote unless has_remotes?
-      repo.fetch(remote || DEFAULT_REMOTE, {:credentials => credentials})
+
+      repo.fetch(remote || DEFAULT_REMOTE, credentials: credentials)
     end
 
     # Merge two refs
@@ -60,8 +64,9 @@ module ChangeAgent
     # Options:
     #  :from   - the remote ref (default: "origin/master")
     #  :to     - the local ref  (default: "refs/heads/master")
-    def merge(options={})
-      options.merge! :from => DEFAULT_REMOTE_BRANCH, :to => DEFAULT_LOCAL_REF
+    def merge(options = {})
+      options[:from] = DEFAULT_REMOTE_BRANCH
+      options[:to] = DEFAULT_LOCAL_REF
       theirs = repo.rev_parse options[:from]
       ours = repo.rev_parse options[:to]
 
@@ -74,11 +79,11 @@ module ChangeAgent
       raise MergeConflict if index.conflicts?
 
       Rugged::Commit.create(repo, {
-        parents: [ours, theirs],
-        tree: index.write_tree(repo),
-        message: "Merged `#{options[:from]}` into `#{options[:to].sub("refs/heads/", "")}`",
-        update_ref: options[:to]
-      })
+                              parents: [ours, theirs],
+                              tree: index.write_tree(repo),
+                              message: "Merged `#{options[:from]}` into `#{options[:to].sub('refs/heads/', '')}`",
+                              update_ref: options[:to]
+                            })
     end
 
     # Fetch a remote and merge
@@ -87,7 +92,7 @@ module ChangeAgent
     #  :remote - the name of the remote (default: origin)
     #  :from   - the remote ref (default: "origin/master")
     #  :to     - the local ref  (default: "refs/heads/master")
-    def pull(options={})
+    def pull(options = {})
       fetch(options[:remote])
       merge(options)
     end

data/lib/change_agent/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ChangeAgent
-  VERSION = "0.2.2"
+  VERSION = '0.2.4'
 end

data/lib/change_agent.rb

@@ -1,17 +1,17 @@
-require_relative "change_agent/version"
-require_relative "change_agent/document"
-require_relative "change_agent/sync"
-require_relative "change_agent/client"
-require "rugged"
+# frozen_string_literal: true
+
+require_relative 'change_agent/version'
+require_relative 'change_agent/document'
+require_relative 'change_agent/sync'
+require_relative 'change_agent/client'
+require 'rugged'
 require 'pathname'
-require "dotenv"
+require 'dotenv'
 
 module ChangeAgent
-
-  def self.init(directory=nil, remote=nil)
+  def self.init(directory = nil, remote = nil)
     Client.new(directory, remote)
   end
-
 end
 
 Dotenv.load

data/script/cibuild

@@ -9,4 +9,6 @@ fi
 
 bundle exec rake test
 
+bundle exec rubocop
+
 rm -Rf tmp

data/test/helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rubygems'
 require 'bundler'
 require 'minitest/autorun'
@@ -6,7 +8,7 @@ require 'shoulda'
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
 def tempdir
-  File.expand_path "./tmp", File.dirname(__FILE__)
+  File.expand_path './tmp', File.dirname(__FILE__)
 end
 
 def init_tempdir

data/test/test_change_agent.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
+
 require 'helper'
 
 class TestChangeAgent < Minitest::Test
-
   def setup
     init_tempdir
   end
@@ -10,7 +11,7 @@ class TestChangeAgent < Minitest::Test
     FileUtils.rm_rf tempdir
   end
 
-  should "return a ChangeAgent::Client" do
+  should 'return a ChangeAgent::Client' do
     assert_equal ChangeAgent::Client, ChangeAgent.init(tempdir).class
   end
 end

data/test/test_change_agent_client.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
+
 require 'helper'
 
 class TestChangeAgentClient < Minitest::Test
-
   def setup
     init_tempdir
     @client = ChangeAgent::Client.new(tempdir)
@@ -11,58 +12,63 @@ class TestChangeAgentClient < Minitest::Test
     FileUtils.rm_rf tempdir
   end
 
-  should "set the directory on init" do
+  should 'set the directory on init' do
     assert_equal tempdir, @client.directory
   end
 
-  should "clone into existing repos" do
-    repo = "https://github.com/benbalter/change_agent"
+  should 'clone into existing repos' do
+    repo = 'https://github.com/benbalter/change_agent'
     agent = ChangeAgent::Client.new(tempdir, repo)
     assert_equal repo, agent.repo.remotes.first.url
     assert Dir.entries(tempdir).count > 5
   end
 
-  should "default to the pwd" do
+  should 'default to the pwd' do
     assert_equal Dir.pwd, ChangeAgent::Client.new.directory
   end
 
-  should "init the git object" do
+  should 'init the git object' do
     assert_equal Rugged::Repository, @client.repo.class
-    assert_equal tempdir + "/.git/", @client.repo.path
+    assert_equal "#{tempdir}/.git/", @client.repo.path
   end
 
-  should "store a value" do
-    @client.set "foo", "bar"
+  should 'store a value' do
+    @client.set 'foo', 'bar'
     tree = @client.repo.head.target.tree
-    blob = @client.repo.lookup tree["foo"][:oid]
-    assert_equal "bar", blob.content
+    blob = @client.repo.lookup tree['foo'][:oid]
+    assert_equal 'bar', blob.content
   end
 
-  should "store a namespaced value" do
-    @client.set "foo/bar", "baz"
+  should 'store a namespaced value' do
+    @client.set 'foo/bar', 'baz'
     tree = @client.repo.head.target.tree
-    blob = @client.repo.lookup tree.path("foo/bar")[:oid]
-    assert_equal "baz", blob.content
+    blob = @client.repo.lookup tree.path('foo/bar')[:oid]
+    assert_equal 'baz', blob.content
   end
 
   should "retrieve a file's value" do
-    @client.set "foo", "bar"
-    assert_equal "bar", @client.get("foo")
+    @client.set 'foo', 'bar'
+    assert_equal 'bar', @client.get('foo')
   end
 
   should "retrive a namespaced file's value" do
-    @client.set "foo/bar", "baz"
-    assert_equal "baz", @client.get("foo/bar")
+    @client.set 'foo/bar', 'baz'
+    assert_equal 'baz', @client.get('foo/bar')
   end
 
-  should "not err on an unknown value" do
-    refute @client.get "does/not/exist"
+  should 'not err on an unknown value' do
+    refute @client.get 'does/not/exist'
   end
 
-  should "not double save a document" do
-    @client.set "foo", "bar"
+  should 'not double save a document' do
+    @client.set 'foo', 'bar'
     sha = @client.repo.last_commit.oid
-    @client.set "foo", "bar"
+    @client.set 'foo', 'bar'
     assert_equal sha, @client.repo.last_commit.oid
   end
+
+  should 'save UTF-8 encoded values' do
+    @client.set 'foo', '§'
+    assert_equal '§', @client.get('foo')
+  end
 end

data/test/test_change_agent_document.rb

@@ -1,87 +1,88 @@
+# frozen_string_literal: true
+
 require 'helper'
 
 class TestChangeAgentDocument < Minitest::Test
-
   def setup
     init_tempdir
     @client = ChangeAgent::Client.new tempdir
-    @document = ChangeAgent::Document.new("foo", @client)
-    @namespaced_document = ChangeAgent::Document.new("bar/foo", @client)
+    @document = ChangeAgent::Document.new('foo', @client)
+    @namespaced_document = ChangeAgent::Document.new('bar/foo', @client)
   end
 
   def teardown
     FileUtils.rm_rf tempdir
   end
 
-  should "store the document path on init" do
-    assert_equal "foo", @document.path
+  should 'store the document path on init' do
+    assert_equal 'foo', @document.path
   end
 
-  should "accept a client if passed" do
-    doc = ChangeAgent::Document.new("foo", ChangeAgent::Client.new)
-    assert_equal ChangeAgent::Client, doc.instance_variable_get("@client").class
+  should 'accept a client if passed' do
+    doc = ChangeAgent::Document.new('foo', ChangeAgent::Client.new)
+    assert_equal ChangeAgent::Client, doc.instance_variable_get(:@client).class
   end
 
-  should "build a client from a directory" do
-    assert_equal ChangeAgent::Client, @document.instance_variable_get("@client").class
+  should 'build a client from a directory' do
+    assert_equal ChangeAgent::Client, @document.instance_variable_get(:@client).class
   end
 
-  should "expose the git client" do
+  should 'expose the git client' do
     assert_equal Rugged::Repository, @document.repo.class
   end
 
   should "read a file's contents" do
-    @document.contents = "bar"
+    @document.contents = 'bar'
     @document.write
     @document.contents = nil # prevent caching
-    assert_equal "bar", @document.contents
+    assert_equal 'bar', @document.contents
   end
 
   should "write a file's contents" do
-    @document.contents = "bar"
+    @document.contents = 'bar'
     @document.write
     @document.contents = nil # prevent caching
-    assert_equal "bar", @client.get("foo")
+    assert_equal 'bar', @client.get('foo')
   end
 
-  should "commit the document to the repo" do
-    @document.contents = "bar"
+  should 'commit the document to the repo' do
+    @document.contents = 'bar'
     @document.write
     @document.contents = nil # prevent caching
     assert_equal "Updating #{@document.key}", @document.repo.last_commit.message
   end
 
-  should "delete the document" do
-    @document.contents = "bar"
+  should 'delete the document' do
+    @document.contents = 'bar'
     @document.write
     @document.contents = nil # prevent caching
-    assert @client.get "foo"
+    assert @client.get 'foo'
     @document.delete
-    refute @client.get "foo"
+    refute @client.get 'foo'
     assert_equal "Removing #{@document.key}", @document.repo.last_commit.message
   end
 
-  should "allow two files in the same folder" do
-    doc = ChangeAgent::Document.new("foo/bar", @client)
-    doc.contents = "baz"
+  should 'allow two files in the same folder' do
+    doc = ChangeAgent::Document.new('foo/bar', @client)
+    doc.contents = 'baz'
     doc.write
     doc.contents = nil # prevent caching
-    assert_equal "baz", @client.get("foo/bar")
+    assert_equal 'baz', @client.get('foo/bar')
 
-    doc = ChangeAgent::Document.new("foo/bar2", @client)
-    doc.contents = "baz2"
+    doc = ChangeAgent::Document.new('foo/bar2', @client)
+    doc.contents = 'baz2'
     doc.write
     doc.contents = nil # prevent caching
-    assert_equal "baz2", @client.get("foo/bar2")
+    assert_equal 'baz2', @client.get('foo/bar2')
   end
 
   should "know if a file's changed" do
     refute @document.changed?
 
-    @client.set "foo", "bar"
+    @client.set 'foo', 'bar'
     refute @document.changed?
 
-    @document.contents = "baz"
+    @document.contents = 'baz'
     assert @document.changed?
   end
 end

data/test/test_change_agent_sync.rb

@@ -1,62 +1,63 @@
+# frozen_string_literal: true
+
 require 'helper'
 
 class TestChangeAgentSync < Minitest::Test
-
   def setup
     init_tempdir
     @client = ChangeAgent::Client.new tempdir
-    @demo = ChangeAgent::Client.new tempdir, "http://github.com/benbalter/change_agent_demo"
+    @demo = ChangeAgent::Client.new tempdir, 'http://github.com/benbalter/change_agent_demo'
   end
 
   def teardown
     FileUtils.rm_rf tempdir
   end
 
-  should "return the remotes" do
+  should 'return the remotes' do
     assert_equal Rugged::RemoteCollection, @client.remotes.class
   end
 
-  should "add remotes" do
+  should 'add remotes' do
     assert_equal 0, @client.remotes.count
-    @client.add_remote "origin", "https://github.com/benbalter/change_agent_demo"
+    @client.add_remote 'origin', 'https://github.com/benbalter/change_agent_demo'
     assert_equal 1, @client.remotes.count
   end
 
-  should "know when the repo has remotes" do
+  should 'know when the repo has remotes' do
     refute @client.has_remotes?
-    @client.add_remote "origin", "https://github.com/benbalter/change_agent_demo"
+    @client.add_remote 'origin', 'https://github.com/benbalter/change_agent_demo'
     assert @client.has_remotes?
   end
 
-  should "fetch" do
-    @client.add_remote "origin", "https://github.com/benbalter/change_agent_demo"
+  should 'fetch' do
+    @client.add_remote 'origin', 'https://github.com/benbalter/change_agent_demo'
     assert_raises Rugged::ReferenceError do
-      @client.repo.rev_parse "origin/master"
+      @client.repo.rev_parse 'origin/master'
     end
     @client.fetch
-    assert @client.repo.rev_parse "origin/master"
+    assert @client.repo.rev_parse 'origin/master'
   end
 
-  should "merge" do
+  should 'merge' do
     head = @demo.repo.head.target.oid
-    @demo.repo.reset "d877861", :hard
+    @demo.repo.reset 'd877861', :hard
     assert @demo.merge
-    assert_equal "Merged `origin/master` into `master`", @demo.repo.last_commit.message
+    assert_equal 'Merged `origin/master` into `master`', @demo.repo.last_commit.message
     assert head != @demo.repo.head.target.oid
   end
 
-  should "pull" do
+  should 'pull' do
     head = @demo.repo.head.target.oid
-    @demo.repo.reset "d877861", :hard
+    @demo.repo.reset 'd877861', :hard
     assert @demo.pull
-    assert_equal "Merged `origin/master` into `master`", @demo.repo.last_commit.message
+    assert_equal 'Merged `origin/master` into `master`', @demo.repo.last_commit.message
     assert head != @demo.repo.head.target.oid
   end
 
-  should "init credentials" do
-    ENV["GITHUB_TOKEN"] = "foo"
+  should 'init credentials' do
+    ENV['GITHUB_TOKEN'] = 'foo'
     assert_equal Rugged::Credentials::UserPassword, @client.credentials.class
-    assert_equal "x-oauth-basic", @client.credentials.instance_variable_get("@username")
-    assert_equal "foo", @client.credentials.instance_variable_get("@password")
+    assert_equal 'x-oauth-basic', @client.credentials.instance_variable_get(:@username)
+    assert_equal 'foo', @client.credentials.instance_variable_get(:@password)
   end
 end

metadata

@@ -1,99 +1,175 @@
 --- !ruby/object:Gem::Specification
 name: change_agent
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.4
 platform: ruby
 authors:
 - Ben Balter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-29 00:00:00.000000000 Z
+date: 2025-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rugged
+  name: dotenv
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.21'
+        version: '3.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.21'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
-  name: dotenv
+  name: rugged
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.9'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.9'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.15'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.15'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.0'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '10.4'
+        version: '14.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.4'
+        version: '13.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '14.0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: shoulda
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 description: 
 email:
 - ben.balter@github.com
@@ -101,7 +177,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
+- ".github/workflows/ci.yml"
 - ".gitignore"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
@@ -125,7 +205,8 @@ files:
 homepage: https://github.com/benbalter/change-agent
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -141,15 +222,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 3.5.11
 signing_key: 
 specification_version: 4
 summary: A Git-backed key-value store, for tracking changes to documents and other
   files over time.
-test_files:
-- test/helper.rb
-- test/test_change_agent.rb
-- test/test_change_agent_client.rb
-- test/test_change_agent_document.rb
-- test/test_change_agent_sync.rb
+test_files: []