currentable 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 507a8189752407fb3beb69d7ea63a6c39815c6aa
-  data.tar.gz: d9d9f05faacbe82b0da483f6f2cc3ca8606e90b2
+  metadata.gz: 48656fcd0ae564e469b9e469e4de8d4ad7f52ff8
+  data.tar.gz: 173ef4c5547b09cb9d9fedc6c833b58cd8a8c170
 SHA512:
-  metadata.gz: 5a11ad3bb18de07c1eefb55ce28bea8073a95abd232acc5e7f976435114ce72b8890f34bb30285c223faf93205346d5ec77401658aa1e4691f90eee9bad0984c
-  data.tar.gz: e827013b5bd1feddbf949f92ed5c0f75c8e194cdc8539c0534c8ae7bc39001d59b7d7a7d9685b50eb80fd1ff2c9d85c83e1b907008f7cccb5fcac19eb6730040
+  metadata.gz: 82a5e3af042877a7a6b2783bfa9e5d910a205c65f941e833339f068829c9706d494157c1ae50286fa7e63cfd23b317f1e611867e5d51972435fce00d500b667c
+  data.tar.gz: c59a5cdc87a7752f7dd08dd8bafb5931a6051a6051eaff33ef6b099b1622a92c5029ff8a60b6dce6443f93a7e810eb55f156f640391916367bbd80117fd22925

data/README.md

@@ -22,14 +22,28 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+class Person < ActiveRecord::Base
+  include Currentable::Instance
+end
+
+Person.current = Person.find(1)
+
+Person.current
+# => Person(id: 1)
+
+Currentable::Cleaner.clean_all
+
+Person.current
+# => nil
+```
 
-## Development
+The cleaner handles registering all classes that need to be cleaned up.
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+### Rails
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+Middleware will automatically be added to cleanup before and after each request.
 
-## Contributing
+### Sidekiq
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/currentable.
+Middleware will be automatically be added to cleanup before and after each worker.

data/lib/currentable/cleaner.rb

@@ -1,10 +1,21 @@
 module Currentable
+  ##
+  # Cleans up all registered current objects.
+  #
+  # @note Will only clean for objects stored on the calling thread.
+  #
+  # @example
+  #   Currentable::Cleaner.clean_all
   class Cleaner
     class << self
+      ##
+      # Sets all registered {Currentable::Instance} classes current value to nil
+      #
+      # @note Will only clean for objects stored on the calling thread.
       def clean_all
         Currentable::Registry.currents.each do |klass|
           if defined? ::Rails
-            Rails.logger.debug "Cleaning current for #{klass}"
+            ::Rails.logger.debug "Cleaning current for #{klass}"
           end
           klass.current = nil
         end

data/lib/currentable/instance.rb

@@ -1,7 +1,24 @@
 require_relative 'registry'
 
 module Currentable
+  ##
+  # Add the magic to a class.
+  #
+  # @example
+  #   class Person < ActiveRecord::Base
+  #     include Currentable::Instance
+  #
+  #     # ...
+  #
+  #   end
+  #
+  #   Person.current = Person.first
+  #
+  #   Person.current.first_name
+  #   # => "Maddie"
   module Instance
+    ##
+    # @private
     def self.included(klass)
       super
 
@@ -10,15 +27,32 @@ module Currentable
       Currentable::Registry.register_current(klass)
     end
 
+    ##
+    # Methods available on the class
     module ClassMethods
+      ##
+      # Set a current value on the current thread.
+      #
+      # @param current [Object, nil] The value for the current thread.
       def current=(current)
+        if !current.nil? && !current.is_a?(self)
+          raise ArgumentError, "#{current} (#{current.class.name}) is not an instance of #{name}"
+        end
         Thread.current[current_identifier] = current
       end
 
+      ##
+      # Get the threads value for the current
+      #
+      # @return [Object, nil] The value stored for the current thread.
       def current
         Thread.current[current_identifier]
       end
 
+      ##
+      # @private
+      #
+      # The identifier for the current. Used as the thread hash key.
       def current_identifier
         "current.#{name}"
       end

data/lib/currentable/middleware/rails/cleaner.rb

@@ -0,0 +1,30 @@
+require 'currentable/cleaner'
+
+module Currentable
+  module Middleware
+    module Rails
+      ##
+      # @private
+      #
+      # Rails Middleware
+      class Cleaner
+        ##
+        # @private
+        def initialize(app)
+          @app = app
+        end
+
+        ##
+        # @private
+        def call(*args)
+          Currentable::Cleaner.clean_all
+          begin
+            @app.call(*args)
+          ensure
+            Currentable::Cleaner.clean_all
+          end
+        end
+      end
+    end
+  end
+end

data/lib/currentable/middleware/sidekiq/server/cleaner.rb

@@ -0,0 +1,20 @@
+require 'currentable/cleaner'
+
+module Currentable
+  module Middleware
+    module Sidekiq
+      module Server
+        class Cleaner
+          def call(_worker, _job, _queue)
+            Currentable::Cleaner.clean_all
+            begin
+              yield
+            ensure
+              Currentable::Cleaner.clean_all
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/currentable/railtie.rb

@@ -1,9 +1,11 @@
-require_relative 'auto_cleaner'
+require_relative 'middleware/rails/cleaner'
 
 module Currentable
-  class Railtie < Rails::Railtie
+  ##
+  # Auto installs the middleware for clearing currents in a Rails application.
+  class Railtie < ::Rails::Railtie
     initializer 'currentable.install_middleware' do |app|
-      app.middleware.insert_after ActionDispatch::RemoteIp, Currentable::AutoCleaner
+      app.middleware.insert_after ActionDispatch::RemoteIp, Currentable::Middleware::Rails::Cleaner
     end
   end
 end

data/lib/currentable/registry.rb

@@ -1,14 +1,34 @@
 module Currentable
+  ##
+  # @private
+  #
+  # Contains all the classes that are registered as Currentable instances.
   class Registry
+    ##
+    # @private
+    #
+    # Registry lock.
     MUTEX = Mutex.new
 
     class << self
+      ##
+      # @private
+      #
+      # Adds a class as a current
+      #
+      # @param klass [Currentable::Instance] The class instance to register.
       def register_current(klass)
         MUTEX.synchronize do
           _currents.add(klass)
         end
       end
 
+      ##
+      # @private
+      #
+      # Return all currents registered.
+      #
+      # @return [Array<Currentable::Instance>]
       def currents
         MUTEX.synchronize { _currents }
       end

data/lib/currentable/sidetie.rb

@@ -0,0 +1,7 @@
+require_relative 'middleware/sidekiq/server/cleaner'
+
+::Sidekiq.configure_server do |config|
+  config.server_middleware do |chain|
+    chain.add Currentable::Middleware::Sidekiq::Server::Cleaner
+  end
+end

data/lib/currentable/version.rb

@@ -1,3 +1,5 @@
 module Currentable
-  VERSION = '0.1.0'.freeze
+  ##
+  # The current version of the gem.
+  VERSION = '0.2.0'.freeze
 end

data/lib/currentable.rb

@@ -7,5 +7,11 @@ if defined? ::Rails
   require 'currentable/railtie'
 end
 
+if defined? ::Sidekiq
+  require 'currentable/sidetie'
+end
+
+##
+# Adds a .current and .current= method to objects for thread storeage.
 module Currentable
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: currentable
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Maddie Schipper
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-07 00:00:00.000000000 Z
+date: 2018-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -76,11 +76,13 @@ files:
 - README.md
 - Rakefile
 - lib/currentable.rb
-- lib/currentable/auto_cleaner.rb
 - lib/currentable/cleaner.rb
 - lib/currentable/instance.rb
+- lib/currentable/middleware/rails/cleaner.rb
+- lib/currentable/middleware/sidekiq/server/cleaner.rb
 - lib/currentable/railtie.rb
 - lib/currentable/registry.rb
+- lib/currentable/sidetie.rb
 - lib/currentable/version.rb
 homepage: https://github.com/maddiesch/currentable
 licenses: []

data/lib/currentable/auto_cleaner.rb

@@ -1,15 +0,0 @@
-require_relative 'cleaner'
-
-module Currentable
-  class AutoCleaner
-    def initialize(app)
-      @app = app
-    end
-
-    def call(*args)
-      @app.call(*args)
-    ensure
-      Currentable::Cleaner.clean_all
-    end
-  end
-end