Bump version, add spec and fix comments. Use semantic versioning as well.

Author: jayelkaake

.github/workflows/ci.yml

@@ -0,0 +1,27 @@
+name: CI
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby-version: ['3.0', '3.1', '3.2', '3.3']
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+
+      - name: Run specs
+        run: bundle exec rspec

.rspec

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

README.md

@@ -38,10 +38,10 @@ Requires `redis` to be available and installed. That's what it will use for memo
 
 ```ruby
 20.times do
-  DontRepeatFor.new("Everyone/Test", 1.second) { puts "This message will only be displayed once every 1 second."; }
+  DontRepeatFor.new(1.second, "Everyone/Test") { puts "This message will only be displayed once every 1 second."; }
 end
 sleep(1.second)
-DontRepeatFor.new("Everyone/Test", 1.second) { puts "This message will only be displayed once every 1 second."; }
+DontRepeatFor.new(1.second, "Everyone/Test") { puts "This message will only be displayed once every 1 second."; }
 
 # Output:
 # This message will only be displayed once every 1 second.
@@ -54,12 +54,12 @@ DontRepeatFor.new("Everyone/Test", 1.second) { puts "This message will only be d
 user1 = User.new(id: -1)
 user2 = User.new(id: -2)
 20.times do
-  DontRepeatFor.new("User-#{user1.id}/Test", 1.second) { puts "This message will only be displayed once every 1 second for user #{user1.id}."; }
-  DontRepeatFor.new("User-#{user2.id}/Test", 1.second) { puts "This message will only be displayed once every 1 second for user #{user2.id}."; }
+  DontRepeatFor.new(1.second, "User-#{user1.id}/Test") { puts "This message will only be displayed once every 1 second for user #{user1.id}."; }
+  DontRepeatFor.new(1.second, "User-#{user2.id}/Test") { puts "This message will only be displayed once every 1 second for user #{user2.id}."; }
 end
 sleep(1.second)
-DontRepeatFor.new("User-#{user1.id}/Test", 1.second) { puts "This message will only be displayed once every 1 second for user #{user1.id}."; }
-DontRepeatFor.new("User-#{user2.id}/Test", 1.second) { puts "This message will only be displayed once every 1 second for user #{user2.id}."; }
+DontRepeatFor.new(1.second, "User-#{user1.id}/Test") { puts "This message will only be displayed once every 1 second for user #{user1.id}."; }
+DontRepeatFor.new(1.second, "User-#{user2.id}/Test") { puts "This message will only be displayed once every 1 second for user #{user2.id}."; }
 
 # Output:
 # This message will only be displayed once every 1 second for user -1.
@@ -70,7 +70,7 @@ DontRepeatFor.new("User-#{user2.id}/Test", 1.second) { puts "This message will o
 
 # Other Things
 ### Roadmap
-* Make this system compatible with memory-baseds storage and other data storage systems.
+* Make this system compatible with memory-based storage and other data storage systems.
 
 ### Contributing
 Bug reports and pull requests are welcome on GitHub at https://github.com/jayelkaake/dont_repeat_for.

dont_repeat_for.gemspec

@@ -14,25 +14,15 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://www.github.com/jayelkaake/dont_repeat_for"
   spec.license       = "MIT"
 
-  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
-  # to allow pushing to a single host or delete this section to allow pushing to any host.
-  # if spec.respond_to?(:metadata)
-  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
-  # else
-  #   raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
-  # end
-
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "rails", ">= 4.0.0"
+  spec.add_dependency "redis"
 
   spec.add_development_dependency "bundler"
-  spec.add_development_dependency "temping", "~> 3.3.0"
-  spec.add_development_dependency "rake", "~> 12.3.3"
-  spec.add_development_dependency "rspec", '~> 3.4'
-  spec.add_development_dependency "sqlite3", '~> 1.3.11'
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.4"
 
 end

lib/dont_repeat_for.rb

@@ -6,18 +6,18 @@
 # Example 1:
 # ```ruby
 #   20.times do
-#     DontRepeatFor.new("test_dont_repeat/test", 5.minutes) { puts "This message will only be displayed once every 5 minutes.";
+#     DontRepeatFor.new(5.minutes, "test_dont_repeat/test") { puts "This message will only be displayed once every 5 minutes.";
 #     sleep(1.minute)
 #   end
 # ```
 #
-# @hint: You can include an ID in the key to enforce rate limiting for a specific store.
+# @hint: You can include a model ID in the key to enforce rate limiting for a specific model.
 class DontRepeatFor
   attr_accessor :key, :time
 
   ##
-  # @param time [Integer] The amount of seconds that we don't want to repeat the process for
-  # @param key [String]  A unique key to identify the process that we don't want to repeat for the given time
+  # @param time [ActiveSupport::Duration|Integer] The amount of seconds that we don't want to repeat the process for
+  # @param key [String] A unique key to identify the process that we don't want to repeat for the given time
   def initialize(time, key)
     @key = key
     @time = time.to_i

lib/dont_repeat_for/version.rb

@@ -1,3 +1,3 @@
 class DontRepeatFor
-    VERSION = '1.0.0.1'
+    VERSION = '1.0.2'
 end

spec/dont_repeat_for_spec.rb

@@ -0,0 +1,93 @@
+RSpec.describe DontRepeatFor do
+  let(:fake_redis) { FakeRedis.new }
+
+  around do |example|
+    old_redis = $redis if defined?($redis)
+    was_defined = defined?($redis)
+    $redis = fake_redis
+    fake_redis.reset!
+    example.run
+  ensure
+    if was_defined
+      $redis = old_redis
+    else
+      $redis = nil
+    end
+  end
+
+  describe "VERSION" do
+    it "is defined" do
+      expect(DontRepeatFor::VERSION).to be_a(String)
+    end
+  end
+
+  describe "#initialize" do
+    it "executes the block the first time" do
+      executed = false
+      DontRepeatFor.new(300, "test/first_run") { executed = true }
+      expect(executed).to be true
+    end
+
+    it "does not execute the block on a second call with the same key" do
+      call_count = 0
+      2.times { DontRepeatFor.new(300, "test/duplicate") { call_count += 1 } }
+      expect(call_count).to eq(1)
+    end
+
+    it "does not execute the block on any subsequent calls with the same key" do
+      call_count = 0
+      5.times { DontRepeatFor.new(300, "test/many") { call_count += 1 } }
+      expect(call_count).to eq(1)
+    end
+
+    it "executes blocks with different keys independently" do
+      results = []
+      DontRepeatFor.new(300, "test/a") { results << :a }
+      DontRepeatFor.new(300, "test/b") { results << :b }
+      expect(results).to eq([:a, :b])
+    end
+
+    it "converts time to integer" do
+      instance = DontRepeatFor.new(300.5, "test/float") {}
+      expect(instance.time).to eq(300)
+    end
+
+    it "exposes key and time as accessors" do
+      instance = DontRepeatFor.new(600, "test/accessors") {}
+      expect(instance.key).to eq("test/accessors")
+      expect(instance.time).to eq(600)
+    end
+  end
+
+  describe "redis key format" do
+    it "namespaces keys under DontRepeatFor/v1/Keys/" do
+      DontRepeatFor.new(300, "my/custom/key") {}
+      expected_key = "DontRepeatFor/v1/Keys/my/custom/key"
+      expect(fake_redis.expirations).to have_key(expected_key)
+    end
+  end
+
+  describe "expiry" do
+    it "sets the expiry to the given time in seconds" do
+      DontRepeatFor.new(600, "test/expiry") {}
+      expected_key = "DontRepeatFor/v1/Keys/test/expiry"
+      expect(fake_redis.expirations[expected_key]).to eq(600)
+    end
+
+    it "does not set expiry on duplicate calls" do
+      DontRepeatFor.new(600, "test/expiry_once") {}
+      fake_redis.expirations.clear
+      DontRepeatFor.new(600, "test/expiry_once") {}
+      expect(fake_redis.expirations).to be_empty
+    end
+  end
+
+  describe "redis connection" do
+    it "uses $redis global when defined" do
+      executed = false
+      DontRepeatFor.new(300, "test/global_redis") { executed = true }
+      expect(executed).to be true
+      expect(fake_redis.expirations).to have_key("DontRepeatFor/v1/Keys/test/global_redis")
+    end
+  end
+end

spec/spec_helper.rb

@@ -0,0 +1,40 @@
+require "dont_repeat_for"
+
+class FakeRedis
+  def initialize
+    @store = {}
+  end
+
+  def incr(key)
+    @store[key] = (@store[key] || 0) + 1
+  end
+
+  def expire(key, seconds)
+    # no-op for testing — just record that it was called
+    @expirations ||= {}
+    @expirations[key] = seconds
+  end
+
+  def expirations
+    @expirations || {}
+  end
+
+  def reset!
+    @store.clear
+    @expirations = {}
+  end
+end
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.disable_monkey_patching!
+  config.order = :random
+  Kernel.srand config.seed
+end