active_record-associated_object 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '049c38f6aeb242c8ccfee9c15d3e29ace1c8f69eaf67619cdb38b09e5dd97514'
+  data.tar.gz: 911ce88d3257b0db22169f325ca2059b12ecdd8bb7121d7a37368588dce37262
+SHA512:
+  metadata.gz: 0ee5964826318cb28a0a1d4c9e0a383b157e4ec0f2dd908b944c5eec68ddc7179d0d43be37bb65316c91e42318a6104b67eccd7d72194b99b4f3284312204692
+  data.tar.gz: 61df4cf5bc61dd0109650ce1aa95bc1f9e79fd99c2da6e2757429b71cda10b1423d6dda7f29310390fa0c5d01b0a5b77563de4151c277316e7a3e57edf16c699

data/CHANGELOG.md

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

data/Gemfile

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in active_record-associated_object.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "minitest", "~> 5.0"
+gem "debug"
+
+gem "sqlite3"
+
+# Integrations to setup and test with.
+gem "kredis"
+gem "activejob"
+gem "railties"

data/Gemfile.lock

@@ -0,0 +1,103 @@
+PATH
+  remote: .
+  specs:
+    active_record-associated_object (0.1.0)
+      activerecord (>= 6.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (7.0.2.3)
+      actionview (= 7.0.2.3)
+      activesupport (= 7.0.2.3)
+      rack (~> 2.0, >= 2.2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actionview (7.0.2.3)
+      activesupport (= 7.0.2.3)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (7.0.2.3)
+      activesupport (= 7.0.2.3)
+      globalid (>= 0.3.6)
+    activemodel (7.0.2.3)
+      activesupport (= 7.0.2.3)
+    activerecord (7.0.2.3)
+      activemodel (= 7.0.2.3)
+      activesupport (= 7.0.2.3)
+    activesupport (7.0.2.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    builder (3.2.4)
+    concurrent-ruby (1.1.10)
+    crass (1.0.6)
+    debug (1.5.0)
+      irb (>= 1.3.6)
+      reline (>= 0.2.7)
+    erubi (1.10.0)
+    globalid (1.0.0)
+      activesupport (>= 5.0)
+    i18n (1.10.0)
+      concurrent-ruby (~> 1.0)
+    io-console (0.5.11)
+    irb (1.4.1)
+      reline (>= 0.3.0)
+    kredis (1.1.0)
+      activesupport (>= 6.0.0)
+      redis (~> 4.2)
+    loofah (2.16.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    method_source (1.0.0)
+    minitest (5.15.0)
+    nokogiri (1.13.4-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.13.4-x86_64-linux)
+      racc (~> 1.4)
+    racc (1.6.0)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.4.2)
+      loofah (~> 2.3)
+    railties (7.0.2.3)
+      actionpack (= 7.0.2.3)
+      activesupport (= 7.0.2.3)
+      method_source
+      rake (>= 12.2)
+      thor (~> 1.0)
+      zeitwerk (~> 2.5)
+    rake (13.0.6)
+    redis (4.6.0)
+    reline (0.3.1)
+      io-console (~> 0.5)
+    sqlite3 (1.4.2)
+    thor (1.2.1)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    zeitwerk (2.5.4)
+
+PLATFORMS
+  arm64-darwin-20
+  x86_64-linux
+
+DEPENDENCIES
+  active_record-associated_object!
+  activejob
+  debug
+  kredis
+  minitest (~> 5.0)
+  railties
+  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,63 @@
+# ActiveRecord::AssociatedObject
+
+Associate a Ruby PORO with an Active Record class and have it quack like one. Build and extend your domain model relying on the Active Record association to make it unique.
+
+## Usage
+
+```ruby
+# app/models/post.rb
+class Post < ActiveRecord::Base
+end
+
+# Create a standard PORO, but derive attributes from the Post:: namespace and its primary key.
+# app/models/post/publisher.rb
+class Post::Publisher < ActiveRecord::AssociatedObject
+  kredis_datetime :publish_at # Kredis integration generates a "post:publishers:<post_id>:publish_at" key.
+
+  # Both a general `record` method and a `post` method is available to access the associated post.
+  def publish_now
+    transaction do
+      post.update! published: true
+      post.subscribers.post_published post
+    end
+  end
+
+  def publish_later
+    PublishJob.set(wait_until: publish_at).perform_later self
+  end
+end
+
+# Post now has a publisher too.
+Post.first.publisher # => Post::Publisher.new(self) # Where self is Post.first.
+
+class Post::Publisher::PublishJob < ActiveJob::Base
+  def perform(publisher)
+     # Automatic integration via GlobalID means you don't have to do `post.publisher`.
+    publisher.publish_now
+  end
+end
+```
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add active_record-associated_object
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install active_record-associated_object
+
+## 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/[USERNAME]/active_record-associated_object.
+
+## 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,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+task default: :test

data/active_record-associated_object.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative "lib/active_record/associated_object/version"
+
+Gem::Specification.new do |spec|
+  spec.name    = "active_record-associated_object"
+  spec.version = ActiveRecord::AssociatedObject::VERSION
+  spec.authors = ["Kasper Timm Hansen"]
+  spec.email   = ["hey@kaspth.com"]
+
+  spec.summary  = "Associate a Ruby PORO with an Active Record class and have it quack like one."
+  spec.homepage = "https://github.com/kaspth/active_record-associated_object"
+  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"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "activerecord", ">= 6.1"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/active_record/associated_object/railtie.rb

@@ -0,0 +1,6 @@
+class ActiveRecord::AssociatedObject::Railtie < Rails::Railtie
+  initializer "integrations.include" do
+    ActiveRecord::AssociatedObject.include Kredis::Attributes       if defined?(Kredis)
+    ActiveRecord::AssociatedObject.include GlobalID::Identification if defined?(GlobalID)
+  end
+end

data/lib/active_record/associated_object/version.rb

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

data/lib/active_record/associated_object.rb

@@ -0,0 +1,48 @@
+class ActiveRecord::AssociatedObject
+  class << self
+    def inherited(klass)
+      record_klass   = klass.module_parent
+      record_name    = klass.module_parent_name.underscore
+      attribute_name = klass.to_s.demodulize.underscore.to_sym
+
+      unless record_klass.respond_to?(:descends_from_active_record?) && record_klass.descends_from_active_record?
+        raise ArgumentError, "#{record_klass} isn't valid; can only associate with ActiveRecord::Base subclasses"
+      end
+
+      alias_method record_name, :record
+      define_singleton_method(:record_klass)   { record_klass }
+      define_singleton_method(:attribute_name) { attribute_name }
+      delegate :record_klass, :attribute_name, to: :class
+
+      record_klass.class_eval <<~RUBY, __FILE__, __LINE__ + 1
+        def #{attribute_name}
+          @#{attribute_name} ||= #{klass}.new(self)
+        end
+      RUBY
+    end
+
+    def respond_to_missing?(...) = record_klass.respond_to?(...) || super
+    delegate :unscoped, :transaction, to: :record_klass
+
+    def method_missing(method, ...)
+      if !record_klass.respond_to?(method) then super else
+        record_klass.public_send(method, ...).then do |value|
+          value.respond_to?(:each) ? value.map(&attribute_name) : value&.public_send(attribute_name)
+        end
+      end
+    end
+  end
+
+  attr_reader :record
+  delegate :id, :transaction, to: :record
+
+  def initialize(record)
+    @record = record
+  end
+
+  def ==(other)
+    other.is_a?(self.class) && id == other.id
+  end
+end
+
+require_relative "associated_object/railtie" if defined?(Rails::Railtie)

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: active_record-associated_object
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kasper Timm Hansen
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-04-20 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-associated_object.gemspec
+- lib/active_record/associated_object.rb
+- lib/active_record/associated_object/railtie.rb
+- lib/active_record/associated_object/version.rb
+homepage: https://github.com/kaspth/active_record-associated_object
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/kaspth/active_record-associated_object
+  source_code_uri: https://github.com/kaspth/active_record-associated_object
+  changelog_uri: https://github.com/kaspth/active_record-associated_object/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: Associate a Ruby PORO with an Active Record class and have it quack like
+  one.
+test_files: []