audited_async 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 101439f1aa2819b34b3d453563b01328e9b0479841ea969ea297852f51e86582
-  data.tar.gz: 488ab1ca381c6aba19aaa0616b8b01c90aa39057b4ff08325a5d74cbd15c30b4
+  metadata.gz: 6149810ee92e27f07045b28bea8cf9b1ad380a36f45fdf4d94b61889d58a6969
+  data.tar.gz: ec08ea6bbdea4f847437c322ef94aafef077f727fe2e0cdc2f1c0a56a3258a7c
 SHA512:
-  metadata.gz: 8b19734d353d5dedce5c35fdf1f2b65d86bca1ec57bc69c77d9078f853e308d76121e878629664caf48a4d61cdcb0cdcad20bba8a61cbfbbd911924fc391688c
-  data.tar.gz: '08bd25f883373971610ea157d774aea2a6bdde30349df193115d1965b3816a980ea1f8bd29634e205b373fcdacb0c6cc13a20fd0112c9611ce9d4726f0560d2a'
+  metadata.gz: 7378037f865f092a172bdc88065bc633145684ae122a8ff64f81873b21e204cb682a60cd0914a105bf1c36ab03e085f86587cc8d34f902f0a37b5abb7156e749
+  data.tar.gz: c1b43a9aa415b486bb2ce1c64859a222193a6c124f68cb3a95ca1f091a313d5e0fef9d1b9bd990a8c473a7c6947f34dbe9a7b8f79582f8ec4d54d8184bdfdb1b

data/.rubocop.yml

@@ -1,3 +1,3 @@
 inherit_gem:
   wonder-ruby-style:
-    - presets/0.52.1.yml
+    - presets/latest.yml

data/Gemfile

@@ -1,6 +1,3 @@
 source 'https://rubygems.org'
 
-git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
-
-# Specify your gem's dependencies in audited_async.gemspec
 gemspec

data/Gemfile.lock

@@ -1,38 +1,118 @@
 PATH
   remote: .
   specs:
-    audited_async (0.1.2)
+    audited_async (0.2.0)
       audited (>= 4.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (5.1.4)
-      activesupport (= 5.1.4)
-    activerecord (5.1.4)
-      activemodel (= 5.1.4)
-      activesupport (= 5.1.4)
-      arel (~> 8.0)
-    activesupport (5.1.4)
+    actioncable (5.2.0)
+      actionpack (= 5.2.0)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailer (5.2.0)
+      actionpack (= 5.2.0)
+      actionview (= 5.2.0)
+      activejob (= 5.2.0)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.2.0)
+      actionview (= 5.2.0)
+      activesupport (= 5.2.0)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.2.0)
+      activesupport (= 5.2.0)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (5.2.0)
+      activesupport (= 5.2.0)
+      globalid (>= 0.3.6)
+    activemodel (5.2.0)
+      activesupport (= 5.2.0)
+    activerecord (5.2.0)
+      activemodel (= 5.2.0)
+      activesupport (= 5.2.0)
+      arel (>= 9.0)
+    activestorage (5.2.0)
+      actionpack (= 5.2.0)
+      activerecord (= 5.2.0)
+      marcel (~> 0.3.1)
+    activesupport (5.2.0)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (~> 0.7)
+      i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-    arel (8.0.0)
+    arel (9.0.0)
     ast (2.4.0)
-    audited (4.6.0)
-      activerecord (>= 4.0, < 5.2)
+    audited (4.7.1)
+      activerecord (>= 4.0, < 5.3)
+    builder (3.2.3)
+    codeclimate-test-reporter (1.0.8)
+      simplecov (<= 0.13)
     concurrent-ruby (1.0.5)
+    crass (1.0.4)
     diff-lcs (1.3)
-    i18n (0.9.3)
+    docile (1.1.5)
+    erubi (1.7.1)
+    globalid (0.4.1)
+      activesupport (>= 4.2.0)
+    i18n (1.0.1)
       concurrent-ruby (~> 1.0)
+    json (2.1.0)
+    loofah (2.2.2)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.0)
+      mini_mime (>= 0.1.1)
+    marcel (0.3.2)
+      mimemagic (~> 0.3.2)
+    method_source (0.9.0)
+    mimemagic (0.3.2)
+    mini_mime (1.0.0)
+    mini_portile2 (2.3.0)
     minitest (5.11.3)
+    nio4r (2.3.1)
+    nokogiri (1.8.2)
+      mini_portile2 (~> 2.3.0)
     parallel (1.12.1)
-    parser (2.4.0.2)
-      ast (~> 2.3)
+    parser (2.5.1.0)
+      ast (~> 2.4.0)
     powerpack (0.1.1)
+    rack (2.0.5)
+    rack-test (1.0.0)
+      rack (>= 1.0, < 3)
+    rails (5.2.0)
+      actioncable (= 5.2.0)
+      actionmailer (= 5.2.0)
+      actionpack (= 5.2.0)
+      actionview (= 5.2.0)
+      activejob (= 5.2.0)
+      activemodel (= 5.2.0)
+      activerecord (= 5.2.0)
+      activestorage (= 5.2.0)
+      activesupport (= 5.2.0)
+      bundler (>= 1.3.0)
+      railties (= 5.2.0)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
+    railties (5.2.0)
+      actionpack (= 5.2.0)
+      activesupport (= 5.2.0)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
     rainbow (3.0.0)
-    rake (10.5.0)
+    rake (12.3.1)
     rspec (3.7.0)
       rspec-core (~> 3.7.0)
       rspec-expectations (~> 3.7.0)
@@ -46,21 +126,37 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.7.0)
     rspec-support (3.7.1)
-    rubocop (0.52.1)
+    rubocop (0.55.0)
       parallel (~> 1.10)
-      parser (>= 2.4.0.2, < 3.0)
+      parser (>= 2.5)
       powerpack (~> 0.1)
       rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.0, >= 1.0.1)
-    rubocop-rspec (1.22.2)
-      rubocop (>= 0.52.1)
+    rubocop-rspec (1.25.1)
+      rubocop (>= 0.53.0)
     ruby-progressbar (1.9.0)
+    simplecov (0.13.0)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    sprockets (3.7.1)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (0.20.0)
     thread_safe (0.3.6)
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
-    unicode-display_width (1.3.0)
-    wonder-ruby-style (0.0.6)
+    unicode-display_width (1.3.2)
+    websocket-driver (0.7.0)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.3)
+    wonder-ruby-style (0.54.0)
       rubocop (~> 0.49)
       rubocop-rspec (~> 1.15)
 
@@ -69,9 +165,11 @@ PLATFORMS
 
 DEPENDENCIES
   audited_async!
-  bundler (~> 1.16)
-  rake (~> 10.0)
-  rspec (~> 3.0)
+  bundler
+  codeclimate-test-reporter
+  rails
+  rake
+  rspec
   wonder-ruby-style
 
 BUNDLED WITH

data/README.md

@@ -1,7 +1,11 @@
 # AuditedAsync
 
+[![Maintainability](https://api.codeclimate.com/v1/badges/2d4899ab63fcea8a9144/maintainability)](https://codeclimate.com/github/leonardofalk/audited_async/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/2d4899ab63fcea8a9144/test_coverage)](https://codeclimate.com/github/leonardofalk/audited_async/test_coverage)
+
 AuditedAsync is an addon for audited gem which allows to create audits asynchronously using ActiveJob.
 
+It's currently under initial development and I strongly recommend you do not use it in production until it reaches a stable version.
+
 ## Installation
 
 Add this line to your application's Gemfile, right after audited gem:
@@ -17,7 +21,69 @@ And then execute:
 
 ## Usage
 
-All done!
+```ruby
+class Post < ApplicationRecord
+  audited async: true
+end
+```
+
+All done! Although you can configure some stuff, check below.
+
+#### Enabling it programmatically
+
+```ruby
+# config/initializers/audited_async.rb
+
+AuditedAsync.configure do |config|
+  config.enabled  = Rails.env.production?
+end
+```
+
+#### Changing Job execution
+
+```ruby
+# config/initializers/audited_async.rb
+
+AuditedAsync.configure do |config|
+  config.job_name  = 'JobityJob'
+end
+```
+
+Create your own job:
+
+```ruby
+class JobityJob < ApplicationJob
+  queue_as :audits
+
+  def perform(audit_info)
+    # audit_info = {
+    #   class_name:      'Post',
+    #   record_id:       2,
+    #   audited_changes: "{\"json_stringified_changes\": \"with_values\"}",
+    #   action:          one of %w[create update destroy],
+    #   comment:         there will be some string here if audited comments are enabled,
+    # }
+
+    # ...
+    # run your logic
+    # ...
+
+    # job must have this line at the end
+    class_name.constantize.send(:write_audit, attributes)
+    # attributes = {
+    #   audited_changes: {hash_changes: :with_values},
+    #   action:          one of %w[create update destroy],
+    #   comment:         comment, if enabled
+    # }
+  end
+end
+```
+
+To see how the default job performs, [look here](./lib/audited_async/audit_async_job).
+
+## How It Works
+
+AuditedAsync safely inject the `async` option into audited model option using functional programming. If enabled, it'll move audit creation logic into an ActiveJob instance, then it's sent to the queue to be executed later.
 
 ## Development
 
@@ -27,7 +93,11 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/leonardofalk/audited_async. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at <https://github.com/leonardofalk/audited_async>. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## To Do
+
+-   [ ] Elaborate more test cases.
 
 ## License
 

data/audited_async.gemspec

@@ -1,15 +1,15 @@
 
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'audited_async/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'audited_async'
   spec.version       = AuditedAsync::VERSION
-  spec.authors       = [ 'Leonardo Falk' ]
-  spec.email         = %w[ leonardo.falk@hotmail.com ]
+  spec.authors       = ['Leonardo Falk']
+  spec.email         = %w[leonardo.falk@hotmail.com]
 
-  spec.summary       = %q{ Execute audited asynchronously. }
+  spec.summary       = 'Execute audited asynchronously with ActiveJob.'
   spec.description   = spec.summary
   spec.homepage      = 'https://github.com/leonardofalk/audited_async'
   spec.license       = 'MIT'
@@ -18,14 +18,16 @@ Gem::Specification.new do |spec|
     f.match(%r{^(test|spec|features)/})
   end
 
-  spec.bindir        = 'exe'
+  spec.bindir        = 'bin'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = %w[ lib ]
+  spec.require_paths = %w[lib]
 
   spec.add_dependency 'audited', '>= 4.0'
 
-  spec.add_development_dependency 'bundler', '~> 1.16'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'wonder-ruby-style'
+  spec.add_development_dependency 'rails'
+  spec.add_development_dependency 'codeclimate-test-reporter'
 end

data/lib/audited_async.rb

@@ -1,27 +1,70 @@
-require 'active_support'
+require 'audited'
 require 'audited_async/version'
+require 'audited_async/configurator'
 require 'audited_async/audit_async_job'
 
+module AuditedAsync
+  class << self
+    def configure
+      @configurator ||= AuditedAsync::Configurator.new
+
+      yield @configurator
+    end
+
+    def config
+      @configurator
+    end
+  end
+end
+
+module Audited::Auditor::ClassMethods
+  attr_reader :audited_async_enabled
+
+  _audited = instance_method :audited
+
+  define_method :audited do |options = {}|
+    @audited_async_enabled = options.fetch(:async, false) && AuditedAsync.config.enabled?
+
+    _audited.bind(self).(options)
+  end
+
+  alias audited_async_enabled? audited_async_enabled
+end
+
 module Audited::Auditor::AuditedInstanceMethods
-  def audit_create
+  _audit_create  = instance_method :audit_create
+  _audit_update  = instance_method :audit_update
+  _audit_destroy = instance_method :audit_destroy
+
+  def audited_async_enabled?
+    self.class.audited_async_enabled?
+  end
+
+  define_method :audit_create do
+    return _audit_create.bind(self).() unless audited_async_enabled?
+
     perform_async_audit 'create'
   end
 
-  def audit_update
+  define_method :audit_update do
+    return _audit_update.bind(self).() unless audited_async_enabled?
+
     unless (changes = audited_changes).empty? && audit_comment.blank?
       perform_async_audit 'update'
     end
   end
 
-  def audit_destroy
+  define_method :audit_destroy do
+    return _audit_destroy.bind(self).() unless audited_async_enabled?
+
     perform_async_audit 'destroy' unless new_record?
   end
 
   def perform_async_audit(method)
-    AuditedAsync::AuditAsyncJob.perform_later class_name: self.class.name,
-                                              record_id: send(self.class.primary_key.to_sym),
-                                              action: method,
-                                              audited_changes: audited_attributes.to_json,
-                                              comment: audit_comment
+    AuditedAsync.config.job.perform_later class_name: self.class.name,
+                                          record_id: send(self.class.primary_key.to_sym),
+                                          action: method,
+                                          audited_changes: audited_attributes.to_json,
+                                          comment: audit_comment
   end
 end

data/lib/audited_async/configurator.rb

@@ -0,0 +1,16 @@
+module AuditedAsync
+  class Configurator
+    attr_accessor :enabled, :job_name
+
+    def initialize
+      @enabled  = true
+      @job_name = 'AuditedAsync::AuditAsyncJob'
+    end
+
+    alias enabled? enabled
+
+    def job
+      @job_name.constantize
+    end
+  end
+end

data/lib/audited_async/version.rb

@@ -1,3 +1,3 @@
 module AuditedAsync
-  VERSION = '0.1.2'.freeze
+  VERSION = '0.2.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: audited_async
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Leonardo Falk
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2018-02-05 00:00:00.000000000 Z
+date: 2018-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: audited
@@ -28,44 +28,44 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: wonder-ruby-style
   requirement: !ruby/object:Gem::Requirement
@@ -80,7 +80,35 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Execute audited asynchronously.
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Execute audited asynchronously with ActiveJob.
 email:
 - leonardo.falk@hotmail.com
 executables: []
@@ -101,6 +129,7 @@ files:
 - bin/setup
 - lib/audited_async.rb
 - lib/audited_async/audit_async_job.rb
+- lib/audited_async/configurator.rb
 - lib/audited_async/version.rb
 homepage: https://github.com/leonardofalk/audited_async
 licenses:
@@ -122,8 +151,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.4
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
-summary: Execute audited asynchronously.
+summary: Execute audited asynchronously with ActiveJob.
 test_files: []