active_record-ingress 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 44f2df474320f208c7c2070f366716be97f2057418055d80c54977524c4ca03d
+  data.tar.gz: 98540cb40ca317ddcd15cb9a6a73fa1ee922c286f0cb314c5d9dd0f4a550c38f
+SHA512:
+  metadata.gz: b39a3673edd55b026c911eb400e065de09e0505fc6a06e48bb289dcc37b947bbc1569a3a81644a0d27505bca48b52229ef389dd78087c32af2c8da5d8f5f86da
+  data.tar.gz: be2eeb6bb12243b606712df38f76995fed25db05082d9301b14c6e2447b445c854070dc00be0159b3707666ddb6322968539d0b5acd0b02a971f2b54942bf5dd

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-04-27
+
+- Initial release

data/Gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in active_record-ingress.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "sqlite3"
+
+gem "minitest", "~> 5.0"
+gem "minitest-sprint"

data/Gemfile.lock

@@ -0,0 +1,44 @@
+PATH
+  remote: .
+  specs:
+    active_record-ingress (0.1.0)
+      activerecord (>= 6.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (7.0.2.4)
+      activesupport (= 7.0.2.4)
+    activerecord (7.0.2.4)
+      activemodel (= 7.0.2.4)
+      activesupport (= 7.0.2.4)
+    activesupport (7.0.2.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    concurrent-ruby (1.1.10)
+    i18n (1.10.0)
+      concurrent-ruby (~> 1.0)
+    minitest (5.15.0)
+    minitest-sprint (1.2.1)
+      path_expander (~> 1.1)
+    path_expander (1.1.0)
+    rake (13.0.6)
+    sqlite3 (1.4.2)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+
+PLATFORMS
+  arm64-darwin-20
+  x86_64-linux
+
+DEPENDENCIES
+  active_record-ingress!
+  minitest (~> 5.0)
+  minitest-sprint
+  rake (~> 13.0)
+  sqlite3
+
+BUNDLED WITH
+   2.3.11

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Kasper Timm Hansen
+
+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,67 @@
+# ActiveRecord::Ingress
+
+Pass control of Active Record methods to a dedicated object.
+
+## Usage
+
+`ActiveRecord::Ingress` adds proxy forwarding method `ingressed` to any `ActiveRecord::Base` instance.
+
+So `post.ingressed.update(title: "Updated title")` would look up a `Post::Ingresses::Update` class, instance and execute its `perform` method:
+
+```ruby
+# app/models/post/ingresses/update.rb
+class Post::Ingresses::Update < ActiveRecord::Ingress::Base
+  # Each ingress has `params`, containing any passed keyword arguments.
+  # This extracts `params[:title]` and Ruby's keyword arguments handling will prevent accepting other arguments.
+  def perform(title:)
+    post.update(title: title)
+  end
+end
+```
+
+Ingresses can be used to create other forwarding too. Here, a `post.ingressed.prepare` is added:
+
+```ruby
+# app/models/post/ingresses/prepare.rb
+class Post::Ingresses::Publish < ActiveRecord::Ingress::Base
+  def perform
+    # Forwards to `record.transaction`
+    transaction do
+      post.published!
+      Post::Promotions.recognize_recently_published post
+    end
+  end
+end
+```
+
+It's also possible to annotate an ingress on the model side so it's always used:
+
+```ruby
+class Post < ActiveRecord::Base
+  ingressed :publish # defines `publish` that delegates to `ingressed.publish`
+end
+```
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add active_record-ingress
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install active_record-ingress
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kaspth/active_record-ingress.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"

data/active_record-ingress.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "lib/active_record/ingress/version"
+
+Gem::Specification.new do |spec|
+  spec.name    = "active_record-ingress"
+  spec.version = ActiveRecord::Ingress::VERSION
+  spec.authors = ["Kasper Timm Hansen"]
+  spec.email   = ["hey@kaspth.com"]
+
+  spec.summary  = "Pass control of Active Record methods to a dedicated object."
+  spec.homepage = "https://github.com/kaspth/active_record-ingress"
+  spec.license  = "MIT"
+  spec.required_ruby_version = ">= 2.7.0"
+
+  spec.metadata["homepage_uri"]    = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"]   = "#{spec.homepage}/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activerecord", ">= 6.1"
+end

data/lib/active_record/ingress/base/callbacks.rb

@@ -0,0 +1,22 @@
+module ActiveRecord::Ingress::Base::Callbacks
+  extend  ActiveSupport::Concern
+  include ActiveSupport::Callbacks
+
+  included do
+    define_callbacks :perform
+  end
+
+  class_methods do
+    def before_perform(...)
+      set_callback(:perform, :before, ...)
+    end
+
+    def after_perform(...)
+      set_callback(:perform, :after, ...)
+    end
+
+    def around_perform(...)
+      set_callback(:perform, :around, ...)
+    end
+  end
+end

data/lib/active_record/ingress/base.rb

@@ -0,0 +1,40 @@
+class ActiveRecord::Ingress::Base
+  require_relative "base/callbacks"
+  include Callbacks
+
+  singleton_class.attr_reader :perform_with_params
+
+  def initialize(record, params = {})
+    @record, @params = record, params
+  end
+
+  def self.inherited(klass)
+    if alias_name = klass.module_parent_name.chomp("::Ingresses").underscore.presence
+      alias_method alias_name, :record
+    end
+  end
+
+  def self.method_added(name)
+    if name == :perform
+      if instance_method(:perform).arity.nonzero?
+        @perform_with_params = ->(params) { perform(**params.to_h) }
+      else
+        @perform_with_params = ->(params) { perform }
+      end
+    end
+  end
+
+  def self.run(...)
+    new(...).run
+  end
+
+  def run
+    run_callbacks :perform do
+      instance_exec(params, &self.class.perform_with_params)
+    end
+  end
+
+  private
+    attr_reader :record, :params
+    delegate :transaction, to: :record
+end

data/lib/active_record/ingress/proxy.rb

@@ -0,0 +1,16 @@
+class ActiveRecord::Ingress::Proxy
+  def initialize(record)
+    @__record__ = record
+  end
+
+  def method_missing(name, ...)
+    find_record_ingress_named(name).run(__record__, ...)
+  end
+
+  private
+    attr_reader :__record__
+
+    def find_record_ingress_named(name)
+      "#{__record__.class.name}::Ingresses::#{name.to_s.classify}".constantize
+    end
+end

data/lib/active_record/ingress/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module Ingress
+    VERSION = "0.1.0"
+  end
+end

data/lib/active_record/ingress.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative "ingress/version"
+
+module ActiveRecord::Ingress
+  autoload :Base,  "active_record/ingress/base"
+  autoload :Proxy, "active_record/ingress/proxy"
+
+  module Integration
+    def ingressed
+      Proxy.new(self)
+    end
+  end
+
+  module Extension
+    def ingressed(*names)
+      delegate *names, to: :ingressed
+    end
+  end
+end
+
+ActiveSupport.on_load(:active_record) do
+  include ActiveRecord::Ingress::Integration
+  extend  ActiveRecord::Ingress::Extension
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: active_record-ingress
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kasper Timm Hansen
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-04-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+description:
+email:
+- hey@kaspth.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- active_record-ingress.gemspec
+- lib/active_record/ingress.rb
+- lib/active_record/ingress/base.rb
+- lib/active_record/ingress/base/callbacks.rb
+- lib/active_record/ingress/proxy.rb
+- lib/active_record/ingress/version.rb
+homepage: https://github.com/kaspth/active_record-ingress
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/kaspth/active_record-ingress
+  source_code_uri: https://github.com/kaspth/active_record-ingress
+  changelog_uri: https://github.com/kaspth/active_record-ingress/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.11
+signing_key:
+specification_version: 4
+summary: Pass control of Active Record methods to a dedicated object.
+test_files: []