safe_poller 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8eaa6bd230c29bffb5dbd45df7438fc40245d42288d29a0bea87dcee71fb9bf1
+  data.tar.gz: 92dd04bc2757d2f7237daa4be896afa4b5752754631f398c2da4a09e4c00b25c
+SHA512:
+  metadata.gz: 264d72cc9b1844297c110b4304e2ba822f1da92357b8dcba7282cf66af01cd9b451767d0776e0c58acf020b22992a2593af052c712686254d6bfa63a53ca5888
+  data.tar.gz: f65afac92c576f0c468cbd85e918a8b98ba20984cfb3cfec7ae7679e06402aaed398e771a4612e67081831af5c9541120f87012c985b99bfead04b5d52b274a8

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,31 @@
+AllCops:
+  TargetRubyVersion: 2.7
+  NewCops: disable
+  SuggestExtensions: false
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: true
+  CountComments: false
+  Max: 30
+
+Metrics/AbcSize:
+  Max: 30
+
+Metrics/BlockLength:
+  Enabled: true
+  Exclude:
+    - 'spec/**/*'

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders 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, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at nejdetkadir.550@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in safe_poller.gemspec
+gemspec
+
+# Rake is a Make-like program implemented in Ruby [https://github.com/ruby/rake]
+gem 'rake', '~> 13.0'
+
+# Behaviour Driven Development for Ruby [https://github.com/rspec/rspec-metagem]
+gem 'rspec', '~> 3.0'
+
+# RuboCop is a Ruby code style checking and code formatting tool [https://github.com/rubocop/rubocop]
+gem 'rubocop', '~> 1.21'
+
+# Pretty print Ruby objects with proper indentation and colors [https://github.com/awesome-print/awesome_print]
+gem 'awesome_print'
+
+# Pry is a runtime developer console and IRB alternative with powerful introspection capabilities [https://github.com/pry/pry]
+gem 'pry', '~> 0.14.1'

data/Gemfile.lock

@@ -0,0 +1,65 @@
+PATH
+  remote: .
+  specs:
+    safe_poller (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    awesome_print (1.9.2)
+    coderay (1.1.3)
+    diff-lcs (1.5.0)
+    json (2.6.3)
+    method_source (1.0.0)
+    parallel (1.22.1)
+    parser (3.2.2.0)
+      ast (~> 2.4.1)
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.8.0)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.1)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.50.2)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.28.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  arm64-darwin-22
+
+DEPENDENCIES
+  awesome_print
+  pry (~> 0.14.1)
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  safe_poller!
+
+BUNDLED WITH
+   2.4.10

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 nejdetkadir
+
+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,82 @@
+[![Gem Version](https://badge.fury.io/rb/safe_poller.svg)](https://badge.fury.io/rb/safe_poller)
+![test](https://github.com/nejdetkadir/safe_poller/actions/workflows/test.yml/badge.svg?branch=main)
+![rubocop](https://github.com/nejdetkadir/safe_poller/actions/workflows/rubocop.yml/badge.svg?branch=main)
+[![Ruby Style Guide](https://img.shields.io/badge/code_style-rubocop-brightgreen.svg)](https://github.com/rubocop/rubocop)
+![Ruby Version](https://img.shields.io/badge/ruby_version->=_2.7.0-blue.svg)
+
+# Safe Poller
+
+SafePoller is a Ruby gem that provides a safe and reliable way to perform periodic polling operations in multi-threaded environments. It offers a simple and intuitive API for running a block of code at a defined interval, while ensuring thread safety and preventing potential race conditions. SafePoller allows developers to focus on implementing their logic without worrying about thread safety issues.
+
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+```bash
+$ bundle add safe_poller
+```
+
+Or add the following line to the application's Gemfile:
+```ruby
+gem 'safe_poller', github: 'nejdetkadir/safe_poller', branch: 'main'
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+```bash
+gem install safe_poller
+```
+
+
+## Usage
+
+To use SafePoller, simply call the `SafePoller.poll` method, passing in a block of code to be executed at the specified interval:
+```ruby
+poller = SafePoller.poll(interval: 2.0) do
+  # Code to be executed at 2-second intervals
+end
+```
+
+By default, the interval is set to 1 second. You can also specify the duration of the poll by using the `SafePoller.poll_for` method:
+```ruby
+poller = SafePoller.poll_for(30, interval: 2.0) do
+  # Code to be executed every 2 seconds for 30 seconds
+end
+```
+
+Or, you can specify the end time of the poll using the `SafePoller.poll_until` method:
+```ruby
+end_time = Time.now + 60
+poller = SafePoller.poll_until(end_time, interval: 2.0) do
+  # Code to be executed every 2 seconds until 1 minute from now
+end
+```
+
+You can pause and resume the poller using the `pause` and `resume` methods, respectively:
+```ruby
+poller.pause # Pauses the poller
+poller.resume # Resumes the poller
+```
+
+You can check if the poller is currently running or paused using the `running?` and `paused?` methods, respectively:
+```ruby
+poller.running? # Returns true if the poller is running, false otherwise
+poller.paused? # Returns true if the poller is paused, false otherwise
+```
+
+You can stop the poller using the `stop` method:
+```ruby
+poller.stop # Stops the poller
+```
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/nejdetkadir/safe_poller. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/nejdetkadir/safe_poller/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](LICENSE).
+
+## Code of Conduct
+
+Everyone interacting in the SafePoller project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/nejdetkadir/safe_poller/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:rspec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[rspec rubocop]

data/lib/safe_poller/base.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module SafePoller
+  class Base
+    def initialize(**options, &block)
+      @block = block
+      @running = false
+      @paused = false
+      @thread = nil
+      @mutex = Mutex.new
+      @pause_cv = ConditionVariable.new
+      @interval = options.fetch(:interval, 1.0)
+      @until = options.fetch(:until, nil)
+    end
+
+    def start
+      return if @running
+
+      @running = true
+
+      @thread = Thread.new do
+        loop do
+          @mutex.synchronize do
+            @pause_cv.wait(@mutex) if @paused
+          end
+
+          break unless @running
+          break if @until && Time.now >= @until
+
+          @block.call
+
+          sleep @interval
+        end
+      end
+    end
+
+    def stop
+      return unless @running
+
+      @mutex.synchronize do
+        @running = false
+        @paused = false
+        @pause_cv.signal
+      end
+
+      @thread.join
+      @thread = nil
+    end
+
+    def pause
+      return unless @running
+
+      @mutex.synchronize do
+        @paused = true
+      end
+    end
+
+    def resume
+      return unless @running
+
+      @mutex.synchronize do
+        @paused = false
+        @pause_cv.signal
+      end
+    end
+
+    def running?
+      @running
+    end
+
+    def paused?
+      @paused
+    end
+  end
+end

data/lib/safe_poller/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SafePoller
+  VERSION = '0.0.1'
+end

data/lib/safe_poller.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative 'safe_poller/base'
+require_relative 'safe_poller/version'
+
+module SafePoller
+  def self.poll(**options, &block)
+    poller = SafePoller::Base.new(**options, &block)
+    poller.start
+    poller
+  end
+
+  def self.poll_until(until_time, **options, &block)
+    options[:until] = until_time
+    poll(**options, &block)
+  end
+
+  def self.poll_for(duration, **options, &block)
+    options[:until] = Time.now + duration
+    poll(**options, &block)
+  end
+end

data/sig/safe_poller.rbs

@@ -0,0 +1,4 @@
+module SafePoller
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: safe_poller
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- nejdetkadir
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-04-18 00:00:00.000000000 Z
+dependencies: []
+description: |-
+  SafePoller is a Ruby gem that provides a safe and reliable way to perform periodic polling operations in multi-threaded environments.
+                       It offers a simple and intuitive API for running a block of code at a defined interval, while ensuring thread safety and preventing potential race conditions.
+                       SafePoller allows developers to focus on implementing their logic without worrying about thread safety issues.
+email:
+- nejdetkadir.550@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/safe_poller.rb
+- lib/safe_poller/base.rb
+- lib/safe_poller/version.rb
+- sig/safe_poller.rbs
+homepage: https://github.com/nejdetkadir/safe_poller
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/nejdetkadir/safe_poller
+  source_code_uri: https://github.com/nejdetkadir/safe_poller
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: SafePoller is a thread-safe Ruby gem that simplifies the process of periodic
+  polling. It provides a reliable and efficient way to run a block of code at a set
+  interval without the need for complex threading logic. With SafePoller, developers
+  can ensure their polling operations are safe and reliable in multi-threaded environments.
+test_files: []