progressrus 0.1.8 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a1e63f1c18708a23b56833afb791eaf7bc27e05243fd4abbd65290e3100d5bf8
-  data.tar.gz: 5387f3c957800d8292ea2f5ebb81b7e5fdacb3a4d045c0f9b2fb14686256f97f
+  metadata.gz: 3cb4b7ee45de1db397c2d3f3cfb720507d8d0cec3f868ae5bf9c206b6f3d0dcf
+  data.tar.gz: 624910bddff5383982e2b24f9a179470b17d0191b503c7c111e6199bbbfa47a8
 SHA512:
-  metadata.gz: a5039104d899d32e43c908213170555ef5ab1b7031af6099497328195d6985643725c4b09cbd5411edbce03769cd98fcd368e2eca54a79ad78e86a471ba99a01
-  data.tar.gz: 5ff5e57e00cd6ff54bc35479047a0d40ae41691fb34324697600f5c4c47b983128bc64e1165102f6e3d187f76aeaffa4e6d6920ca92c5adffd3b573d88711b77
+  metadata.gz: 5a8e7967dff752a13e2f4a914283855568a5f443782b5d0b146ca78fa425b100597e7d8be282ac6e90a1f3e83a8aa015294df56e2d690d15b61df1a2b65171aa
+  data.tar.gz: 5ccbeffcf9168949764092b5a3f2b3b024302f40852e81ee217ba8480f6b1c688303d895a461fa355e285329461463d078518b331d4eb9d79e5f1a6f298c8843

data/lib/progressrus.rb

@@ -2,29 +2,65 @@ 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 << 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
 
@@ -84,7 +120,7 @@ class Progressrus
   end
 
   def flush
-    stores.each { |store| store.flush(scope, id) }
+    stores.each_value { |store| store.flush(scope, id) }
   end
 
   def status
@@ -161,7 +197,7 @@ class Progressrus
   private
 
   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/lib/progressrus/version.rb

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

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

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
@@ -196,19 +203,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 +242,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
+  def test_default_scope_redis_store
+    Progressrus.clear_stores
 
-    Progressrus.scope(["oemg"])
-  end
-
-  def test_support_scope_last
-    Progressrus.stores.clear
-
-    mysql = mock()
-    redis = mock()
+    mysql = mock_store
+    redis = mock_store
 
-    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 +420,10 @@ class ProgressrusTest < Minitest::Test
 
     refute progress.expired?(now: time)
   end
+
+  private
+
+  def mock_store
+    Progressrus::Store::Base.new
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: progressrus
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 1.0.0
 platform: ruby
 authors:
 - Simon Eskildsen
@@ -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

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