laters 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c6ad4e042b43cac1765ea61b494fc1ec86ebe4fcfb68c888be4e2a7fdded4985
+  data.tar.gz: 86b3ffe9dab1b85dc2ca73dac4417d3a8b71d25aadda551927e32d4389784a64
+SHA512:
+  metadata.gz: ce904311b5114eef4e8c7b4d2569a49c46ca17e184a570ae3829eda0a7f508b850fba966307d8de583eecb253e683a3280aee9ebfe793b90ee67d9d58085199e
+  data.tar.gz: 2c8d9566b52771b4494bc01736f5db1e677d68a5ff36798534d18440ee0e9245c5bd8380ac6b8dcb73916523382b7de4c66e7e7e311384e235308b808d5a0073

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# 0.1.1 (23-8-2020)
+
+- Rename gem to `laters`
+
+# 0.1.0 (23-8-2020)
+
+- Initial version

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at kieranklaassen@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Kieran Klaassen
+
+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,77 @@
+# Laters
+
+Run any instance_method of ActiveRecord models via a job by adding `_later` to it. Laters 👋, means See you later in
+Dutch 🇳🇱
+
+## Installation
+
+Add to your Gemfile
+
+    $ bundle add laters
+
+Or install it yourself as:
+
+    $ gem install laters
+
+## Usage
+
+1. Include the `Laters::Concern` in your model
+2. Call instance methods with `_later`
+
+```rb
+class User < ApplicationRecord
+  include Laters::Concern
+
+  after_create_commit :notify_user_later
+  after_commit :refresh_cache_later
+
+  private
+
+  def notify_user
+    # External services
+    Sms.send(to: user.phone, message: 'Hey!')
+  end
+
+  def refresh_cache!
+    # Expensive calculation
+  end
+end
+```
+
+To set the queue to any other than the `default` set it like this:
+
+```rb
+class User < ApplicationRecord
+  include Laters::Concern
+
+  run_in_queue :low
+end
+```
+
+If you need callbacks, they are provided as standart model callbacks:
+
+```rb
+class User < ApplicationRecord
+  include Laters::Concern
+
+  before_laters :do_something
+  after_laters :do_something_more
+  around_laters :do_something_around
+  # Etc..
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kieranklaassen/laters. 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/kieranklaassen/laters/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Laters project's codebases, issue trackers, chat rooms and mailing lists is expected to
+follow the [code of conduct](https://github.com/kieranklaassen/laters/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/app/jobs/laters/instance_method_job.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Laters
+  class InstanceMethodJob < ActiveJob::Base
+    def perform(object, method_name, *args)
+      if object.respond_to? :id
+        Rails.logger.info "Calling deferred #{method_name} on #{object.class} ##{object.id}"
+      else
+        Rails.logger.info "Calling deferred #{object.class}##{method_name}"
+      end
+
+      object.run_callbacks(:laters) { object.send(method_name, *args) }
+    end
+  end
+end

data/app/models/concerns/laters/concern.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Laters
+  module Concern
+    extend ActiveSupport::Concern
+    include ActiveModel::Callbacks
+
+    included { define_model_callbacks :laters }
+
+    class_methods do
+      attr_reader :job_queue
+
+      private
+
+      def run_in_queue(queue)
+        @job_queue = queue
+      end
+    end
+
+    private
+
+    def method_missing(method, *args, &block)
+      if (method_to_call = deferrable_method_name(method))
+        InstanceMethodJob
+          .set(queue: self.class.job_queue || :default)
+          .perform_later(self, method_to_call, *args)
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      method_name.to_s.ends_with?('_later') || super
+    end
+
+    # @param [Symbol] deferring_method Name of the deferring method that was called
+    def deferrable_method_name(deferring_method)
+      return unless (method = deferring_method.to_s).ends_with? '_later'
+
+      method.chomp! '_later'
+      if respond_to? "#{method}!", true
+        "#{method}!"
+      elsif respond_to? method, true
+        method
+      end
+    end
+  end
+end

data/lib/laters.rb

@@ -0,0 +1,14 @@
+require 'laters/version'
+require 'active_model'
+require 'active_job'
+require 'zeitwerk'
+loader = Zeitwerk::Loader.for_gem
+loader.push_dir('app/models/concerns')
+loader.push_dir('app/jobs')
+loader.setup
+
+module Laters
+  class Error < StandardError; end
+end
+
+loader.eager_load

data/lib/laters/version.rb

@@ -0,0 +1,3 @@
+module Laters
+  VERSION = '0.1.1'.freeze
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: laters
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Kieran Klaassen
+- Pelle ten Cate
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-08-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Deferrable empowers a class to run every single defined method wrapped
+  in an ActiveJob of any class that includes it
+email:
+- kieranklaassen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/jobs/laters/instance_method_job.rb
+- app/models/concerns/laters/concern.rb
+- lib/laters.rb
+- lib/laters/version.rb
+homepage: https://github.com/kieranklaassen/laters
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/kieranklaassen/laters
+  source_code_uri: https://github.com/kieranklaassen/laters
+  changelog_uri: https://github.com/kieranklaassen/laters/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Run any instance_method in ActiveRecord models via a job by adding `_later`
+  to it.
+test_files: []