progressrus 0.1.8 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a1e63f1c18708a23b56833afb791eaf7bc27e05243fd4abbd65290e3100d5bf8
-  data.tar.gz: 5387f3c957800d8292ea2f5ebb81b7e5fdacb3a4d045c0f9b2fb14686256f97f
+  metadata.gz: d353cca4bf4eca46acd2837f9e62f6dbe35834cd3efe00bf66ece1c02a2924d0
+  data.tar.gz: 2b8c0dc2e6ec18c4f22b3a911bedfbcd73232517c4576dcc4971c46fc7abaabb
 SHA512:
-  metadata.gz: a5039104d899d32e43c908213170555ef5ab1b7031af6099497328195d6985643725c4b09cbd5411edbce03769cd98fcd368e2eca54a79ad78e86a471ba99a01
-  data.tar.gz: 5ff5e57e00cd6ff54bc35479047a0d40ae41691fb34324697600f5c4c47b983128bc64e1165102f6e3d187f76aeaffa4e6d6920ca92c5adffd3b573d88711b77
+  metadata.gz: d1b1f0472d3ed65a214a020433315f7dd9cc37618fe992125e9a8836b320e0b92cc3adb5dca28f9109f15bb670abf6392a9493df3e7bd5921b9206f78e9d0b3c
+  data.tar.gz: 9823e1025dff167ffc79e33d12cc636fd5494a23cf5c97500fb655eb69a5aabbb0df45518ed8928f11ac41cf8b62f9f0f196d125cde2f3f98b0e5e3980206e21

data/.github/workflows/ci.yml

@@ -0,0 +1,38 @@
+name: CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ["2.6", "2.7", "3.0", "3.1"]
+    services:
+      redis:
+        image: redis
+        options: >-
+          --health-cmd "redis-cli ping"
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        ports:
+          - 6379:6379
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+      uses: ruby/setup-ruby@v1
+      with:
+        bundler-cache: true # 'bundle install' and cache gems
+        ruby-version: ${{ matrix.ruby }}
+    - name: Run tests
+      run: bundle exec rake

data/lib/progressrus/core_ext/enumerable.rb

@@ -1,5 +1,5 @@
 module Enumerable
-  def with_progress(**args, &block)
+  def with_progress(args = {}, &block)
     if block_given?
       progresser = progress(args)
       begin
@@ -25,7 +25,7 @@ module Enumerable
       # Lazily read the size, for some enumerable this may be quite expensive and
       # using this method should come with a warning in the documentation.
       total = self.size unless args[:total]
-      @progress = Progressrus.new({total: total}.merge(args))
+      @progress = Progressrus.new(total: total, **args)
     end
   end
 end

data/lib/progressrus/store/redis.rb

@@ -17,9 +17,9 @@ class Progressrus
         if outdated?(progress) || force
           key_for_scope = key(progress.scope)
 
-          redis.pipelined do
-            redis.hset(key_for_scope, progress.id, progress.to_serializeable.to_json)
-            redis.expireat(key_for_scope, expires_at.to_i) if expires_at
+          redis.pipelined do |pipeline|
+            pipeline.hset(key_for_scope, progress.id, progress.to_serializeable.to_json)
+            pipeline.expireat(key_for_scope, expires_at.to_i) if expires_at
           end
 
           @persisted_ats[progress.scope][progress.id] = now
@@ -31,7 +31,7 @@ class Progressrus
       def scope(scope)
         scope = redis.hgetall(key(scope))
         scope.each_pair { |id, value|
-          scope[id] = Progressrus.new(deserialize(value))
+          scope[id] = Progressrus.new(**deserialize(value))
         }
       rescue *BACKEND_EXCEPTIONS => e
         raise Progressrus::Store::BackendError.new(e)
@@ -41,7 +41,7 @@ class Progressrus
         value = redis.hget(key(scope), id)
         return unless value
 
-        Progressrus.new(deserialize(value))
+        Progressrus.new(**deserialize(value))
       rescue *BACKEND_EXCEPTIONS => e
         raise Progressrus::Store::BackendError.new(e)
       end

data/lib/progressrus/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class Progressrus
-  VERSION = '0.1.8'
+  VERSION = '1.0.3'
 end

data/lib/progressrus.rb

@@ -2,29 +2,75 @@ require 'json'
 require 'securerandom'
 require 'redis'
 require 'time'
-require_relative "progressrus/store"
 require_relative "progressrus/store/base"
 require_relative "progressrus/store/redis"
 require_relative "progressrus/store/progressbar"
 require_relative "progressrus/core_ext/enumerable"
 
 class Progressrus
+  @mutex = Mutex.new
+
+  class InvalidStoreError < StandardError
+    def initialize
+      message = <<~MSG
+        The store needs to implement `persist`, `scope`, `find` and `flush`
+        We have a base class that your store can inherit from:
+          Progressrus::Store::Base
+      MSG
+      super(message)
+    end
+  end
+
+  class StoreNotFoundError < StandardError
+    def initialize(store)
+      message = <<~MSG
+        The store `#{store}` does not exists.
+        Available stores: #{Progressrus.stores.keys.join(', ')}
+      MSG
+      super(message)
+    end
+  end
+
   class << self
+    attr_reader :mutex
+
+    def clear_stores
+      @stores = {}
+    end
+
     def stores
-      @@stores ||= Store.new(Store::Redis.new(::Redis.new(host: ENV["PROGRESSRUS_REDIS_HOST"] || "localhost")))
+      mutex.synchronize do
+        @stores ||= {
+          redis: Store::Redis.new(::Redis.new(host: ENV["PROGRESSRUS_REDIS_HOST"] || "localhost"))
+        }
+      end
     end
 
-    def scope(scope, store: :first)
-      stores.find_by_name(store).scope(scope)
+    def add_store(name, store)
+      validate_store!(store)
+      stores[name] = store
+    end
+
+    def scope(scope, store: :redis)
+      stores[store].scope(scope)
     end
     alias_method :all, :scope
 
-    def find(scope, id, store: :first)
-      stores.find_by_name(store).find(scope, id)
+    def find(scope, id, store: :redis)
+      stores[store].find(scope, id)
+    end
+
+    def flush(scope, id = nil, store: :redis)
+      stores[store].flush(scope, id)
     end
 
-    def flush(scope, id = nil, store: :first)
-      stores.find_by_name(store).flush(scope, id)
+    private
+
+    def validate_store!(store)
+      valid = Store::Base.new.public_methods(false).all? do |method|
+        store.respond_to?(method)
+      end
+      raise InvalidStoreError unless valid
     end
   end
 
@@ -38,7 +84,7 @@ class Progressrus
   attr_writer :params
 
   def initialize(scope: "progressrus", total: nil, name: nil,
-    id: SecureRandom.uuid, params: {}, stores: Progressrus.stores,
+    id: SecureRandom.uuid, params: {}, stores: nil,
     completed_at: nil, started_at: nil, count: 0, failed_at: nil,
     error_count: 0, persist: false, expires_at: nil, persisted: false)
 
@@ -49,7 +95,7 @@ class Progressrus
     @total        = total
     @id           = id
     @params       = params
-    @stores       = stores
+    @stores       = extract_stores(stores)
     @count        = count
     @error_count  = error_count
 
@@ -84,7 +130,7 @@ class Progressrus
   end
 
   def flush
-    stores.each { |store| store.flush(scope, id) }
+    stores.each_value { |store| store.flush(scope, id) }
   end
 
   def status
@@ -160,8 +206,19 @@ class Progressrus
 
   private
 
+  def extract_stores(stores)
+    return Progressrus.stores unless stores
+
+    Array(stores).each_with_object({}) do |store, hash|
+      stored_found = Progressrus.stores[store]
+      raise StoreNotFoundError, store unless stored_found
+
+      hash[store] = stored_found
+    end
+  end
+
   def persist(force: false)
-    stores.each do |store|
+    stores.each_value do |store|
       begin
         store.persist(self, force: force, expires_at: expires_at)
       rescue Progressrus::Store::BackendError

data/tasks/redis_store.rake

@@ -7,7 +7,7 @@ namespace :progressrus do
     task :flush, :environment do |t, args|
       scope = *args
       raise ArgumentError.new("Must pass [scope] to progressrus:store:flush[scope(,parts)] task.") unless scope.length > 0
-      Progressrus.stores.first.flush(scope) if Progressrus.stores.first
+      Progressrus.stores[:redis].flush(scope) if Progressrus.stores[:redis]
     end
   end
 end

data/test/integration_test.rb

@@ -6,7 +6,7 @@ class IntegrationTest < Minitest::Test
   end
 
   def teardown
-    Progressrus.stores.first.flush(@progress.scope)
+    Progressrus.stores[:redis].flush(@progress.scope)
   end
 
   def test_create_tick_and_see_status_in_redis
@@ -44,7 +44,7 @@ class IntegrationTest < Minitest::Test
   end
 
   def test_tick_on_enumerable
-    a = (0..10)
+    a = (0..10).to_a
     b = a.with_progress(scope: "walrus").map(&:to_i)
 
     ticks = Progressrus.scope(["walrus"]).values
@@ -57,7 +57,7 @@ class IntegrationTest < Minitest::Test
   end
 
   def test_tick_on_enumerable_calls_fail_on_exception
-    a = (0..10)
+    a = (0..10).to_a
 
     assert_raises ArgumentError do
       a.with_progress(scope: "walrus").each do

data/test/progressrus_test.rb

@@ -6,16 +6,23 @@ class ProgressrusTest < Minitest::Test
   end
 
   def teardown
-    Progressrus.stores.default!
+    Progressrus.clear_stores
+    Progressrus.add_store(:redis, Progressrus::Store::Redis.new(::Redis.new(host: ENV["PROGRESSRUS_REDIS_HOST"] || "localhost")))
   end
 
   def test_defaults_to_redis_store
-    assert_instance_of Progressrus::Store::Redis, Progressrus.stores.first
+    assert_instance_of Progressrus::Store::Redis, Progressrus.stores[:redis]
   end
 
   def test_add_to_store
-    Progressrus.stores << Progressrus::Store::Base.new
-    assert_instance_of Progressrus::Store::Base, Progressrus.stores[1]
+    Progressrus.add_store(:test, Progressrus::Store::Base.new)
+    assert_instance_of Progressrus::Store::Base, Progressrus.stores[:test]
+  end
+
+  def test_add_store_raise_error_when_invalid_store
+    assert_raises(Progressrus::InvalidStoreError) do
+      Progressrus.add_store(:test, mock)
+    end
   end
 
   def test_scope_should_initialize_with_symbol_or_string
@@ -33,6 +40,37 @@ class ProgressrusTest < Minitest::Test
     assert_equal 'Wally', progressrus.name
   end
 
+  def test_not_passing_stores_default_to_all_stores
+    progressrus = Progressrus.new(scope: ['walruses', 1])
+    assert_equal Progressrus.stores, progressrus.stores
+  end
+
+  def test_passing_stores
+    mysql = mock_store
+    Progressrus.add_store(:mysql, mysql)
+    progressrus = Progressrus.new(scope: ['walruses', 1], stores: :mysql)
+    assert_equal({ mysql: mysql }, progressrus.stores)
+  end
+
+  def test_passing_multiple_stores
+    Progressrus.clear_stores
+
+    mysql = mock_store
+    redis = mock_store
+
+    Progressrus.add_store(:mysql, mysql)
+    Progressrus.add_store(:redis, redis)
+
+    progressrus = Progressrus.new(scope: ['walruses', 1], stores: %i(mysql redis))
+    assert_equal({ mysql: mysql, redis: redis }, progressrus.stores)
+  end
+
+  def test_passing_non_existing_store_raises_error
+    assert_raises(Progressrus::StoreNotFoundError) do
+      Progressrus.new(scope: ['walruses', 1], stores: :not_found)
+    end
+  end
+
   def test_initialize_without_name_should_use_id
     progressrus = Progressrus.new(id: 'oemg')
     assert_equal 'oemg', progressrus.name
@@ -196,19 +234,20 @@ class ProgressrusTest < Minitest::Test
   end
 
   def test_persist_yields_persist_to_each_store
-    mysql = mock()
+    mysql = mock_store
     mysql.expects(:persist).once
 
-    redis = Progressrus.stores.first
+    redis = Progressrus.stores[:redis]
     redis.expects(:persist).once
 
-    Progressrus.stores << mysql
+    Progressrus.add_store(:mysql, mysql)
 
-    @progress.tick
+    progress = Progressrus.new(scope: :progressrus, total: 100)
+    progress.tick
   end
 
   def test_tick_and_complete_dont_raise_if_store_is_unavailable
-    store = Progressrus.stores.first
+    store = Progressrus.stores[:redis]
     store.redis.expects(:hset).at_least_once.raises(::Redis::BaseError)
     @progress.tick
     @progress.complete
@@ -234,47 +273,32 @@ class ProgressrusTest < Minitest::Test
   end
 
 
-  def test_default_scope_on_first
-    Progressrus.stores.clear
-
-    mysql = mock()
-    redis = mock()
-
-    Progressrus.stores << mysql
-    Progressrus.stores << redis
-
-    mysql.expects(:scope).once
-    redis.expects(:scope).never
-
-    Progressrus.scope(["oemg"])
-  end
+  def test_default_scope_redis_store
+    Progressrus.clear_stores
 
-  def test_support_scope_last
-    Progressrus.stores.clear
+    mysql = mock_store
+    redis = mock_store
 
-    mysql = mock()
-    redis = mock()
-
-    Progressrus.stores << mysql
-    Progressrus.stores << redis
+    Progressrus.add_store(:mysql, mysql)
+    Progressrus.add_store(:redis, redis)
 
     mysql.expects(:scope).never
     redis.expects(:scope).once
 
-    Progressrus.scope(["oemg"], store: :last)
+    Progressrus.scope(["oemg"])
   end
 
   def test_support_scope_by_name
-    Progressrus.stores.clear
+    Progressrus.clear_stores
 
-    mysql = mock()
-    redis = mock()
+    mysql = mock_store
+    redis = mock_store
 
     mysql.stubs(:name).returns(:mysql)
     redis.stubs(:name).returns(:redis)
 
-    Progressrus.stores << mysql
-    Progressrus.stores << redis
+    Progressrus.add_store(:mysql, mysql)
+    Progressrus.add_store(:redis, redis)
 
     mysql.expects(:scope).never
     redis.expects(:scope).once
@@ -427,4 +451,10 @@ class ProgressrusTest < Minitest::Test
 
     refute progress.expired?(now: time)
   end
+
+  private
+
+  def mock_store
+    Progressrus::Store::Base.new
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: progressrus
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 1.0.3
 platform: ruby
 authors:
 - Simon Eskildsen
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-09-03 00:00:00.000000000 Z
+date: 2022-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -129,8 +129,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
-- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -139,7 +139,6 @@ files:
 - lib/progressrus/core_ext/enumerable.rb
 - lib/progressrus/railtie.rb
 - lib/progressrus/server.rb
-- lib/progressrus/store.rb
 - lib/progressrus/store/base.rb
 - lib/progressrus/store/progressbar.rb
 - lib/progressrus/store/redis.rb
@@ -156,7 +155,7 @@ homepage: https://github.com/Sirupsen/progressrus
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -171,8 +170,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.3.3
+signing_key:
 specification_version: 4
 summary: Monitor the progress of remote, long-running jobs.
 test_files:

data/.travis.yml

@@ -1,7 +0,0 @@
-language: ruby
-services:
-  - redis-server
-rvm:
-  - 2.3
-  - 2.4
-  - 2.5

data/lib/progressrus/store.rb

@@ -1,24 +0,0 @@
-class Progressrus
-  class Store < Array
-    def initialize(default)
-      @default = default
-      self << default
-    end
-
-    def default
-      @default
-    end
-
-    def default!
-      clear
-      self << default
-    end
-
-    def find_by_name(name)
-      return first if name == :first
-      return last  if name == :last
-
-      find { |store| store.name == name }
-    end
-  end
-end