alias_association 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c55602c05ac4f57d4ac0e12280430d9bf8d26f18d54f4bd1a0cb4e7c64c05ce8
+  data.tar.gz: 39a19f8e93d3f28bde78ae8a4f6165db2ec28ff5b32cd0a491af1a86d12eed21
+SHA512:
+  metadata.gz: df8dbf406445c1729273d0c64233fc2323fe38aa1ffaa65663e13cf9e163af8ea3226ccefcff1a9967528f24c15cf28f78ed17132d8ecca815154ff76a1c11f2
+  data.tar.gz: 20b7efaba74f77bf5d643ca604db022820edd562e8c629027fc454b5d6b61a79d84780fab4ee2980b122d68912943f86a7b6adfe5439b6253e10f5844e2c2eac

data/CHANGELOG.md

@@ -0,0 +1,18 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.0.0] - 2025-10-19
+
+### Added
+- Initial extraction of `AliasAssociation` concern from main Rails application
+- `alias_association` class method to create aliases for ActiveRecord associations
+- Automatic creation of both getter and setter methods for aliased associations
+- Error handling for invalid association references
+- `association_aliases` method for debugging and introspection
+- Comprehensive test suite
+- Detailed documentation and usage examples in README
+- Ruby 3.0+ and Rails 6.0+ compatibility

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in alias_relationship.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
+gem "sqlite3", "~> 1.4"

data/README.md

@@ -0,0 +1,108 @@
+# AliasAssociation
+
+[![Gem Version](https://badge.fury.io/rb/alias_association.svg)](https://badge.fury.io/rb/alias_association)
+[![RSpec](https://github.com/dapi/alias_association/workflows/RSpec/badge.svg)](https://github.com/dapi/alias_association/actions)
+
+AliasAssociation is a Ruby on Rails concern that provides a simple way to create aliases for ActiveRecord associations, including both getter and setter methods.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'alias_association'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+## Usage
+
+Include the `AliasAssociation` concern in your ActiveRecord model and use the `alias_association` class method to create aliases for existing associations.
+
+```ruby
+class Order < ApplicationRecord
+  include AliasAssociation
+
+  belongs_to :user
+  belongs_to :income_payment_system, class_name: 'PaymentSystem'
+  belongs_to :outcome_payment_system, class_name: 'PaymentSystem'
+
+  # Create aliases for associations
+  alias_association :owner, :user
+  alias_association :payment_system_from, :income_payment_system
+  alias_association :payment_system_to, :outcome_payment_system
+end
+```
+
+Now you can use the aliases just like the original associations:
+
+```ruby
+order = Order.first
+
+# Getter methods
+order.owner        # equivalent to order.user
+order.payment_system_from  # equivalent to order.income_payment_system
+order.payment_system_to    # equivalent to order.outcome_payment_system
+
+# Setter methods
+order.owner = User.find(2)        # equivalent to order.user = User.find(2)
+order.payment_system_from = ps    # equivalent to order.income_payment_system = ps
+order.payment_system_to = ps      # equivalent to order.outcome_payment_system = ps
+```
+
+### Error Handling
+
+The concern validates that the original association exists before creating the alias:
+
+```ruby
+class Order < ApplicationRecord
+  include AliasRelationship
+
+  # This will raise an ArgumentError if :nonexistent_association doesn't exist
+  alias_association :alias_name, :nonexistent_association
+  # => ArgumentError: Association :nonexistent_association not found
+```
+
+### Debug Information
+
+You can retrieve information about association aliases for debugging purposes:
+
+```ruby
+Order.association_aliases
+# => { owner: :user, payment_system_from: :income_payment_system, payment_system_to: :outcome_payment_system }
+```
+
+## API Reference
+
+### `alias_association(new_name, original_name)`
+
+Creates an alias for an existing ActiveRecord association.
+
+- **`new_name`** (Symbol) - The name for the new alias
+- **`original_name`** (Symbol) - The name of the existing association to alias
+
+**Raises:** `ArgumentError` if the original association doesn't exist
+
+### `association_aliases`
+
+Returns a hash containing information about all association aliases for the model.
+
+**Returns:** `Hash` with alias names as keys and original association names as values
+
+## Development
+
+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.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/dapi/alias_association.
+
+## 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 "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/alias_association/alias_association_version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module AliasAssociation
+  VERSION = "1.0.0"
+end

data/lib/alias_association.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require_relative "alias_association/alias_association_version"
+require "active_support/concern"
+
+# This module provides functionality to create aliases for ActiveRecord associations
+module AliasAssociation
+  extend ActiveSupport::Concern
+
+  class_methods do
+    # Создает алиас для association, включая геттер и сеттер
+    #
+    # @param new_name [Symbol] новое имя ассоциации
+    # @param original_name [Symbol] оригинальное имя ассоциации
+    #
+    # @example
+    #   belongs_to :user
+    #   alias_association :owner, :user
+    #   # Создаст методы owner и owner=
+    #
+    def alias_association(new_name, original_name)
+      # Проверяем существование оригинальной ассоциации
+      unless reflect_on_association(original_name)
+        raise ArgumentError, "Association #{original_name.inspect} not found"
+      end
+
+      # Создаем alias для геттера
+      alias_method new_name, original_name
+
+      # Создаем alias для сеттера
+      setter_name = "#{new_name}="
+      original_setter_name = "#{original_name}="
+
+      if method_defined?(original_setter_name)
+        alias_method setter_name, original_setter_name
+      end
+
+      # Добавляем информацию об алиасе для возможной отладки
+      @association_aliases ||= {}
+      @association_aliases[new_name] = original_name
+    end
+
+    # Возвращает хэш с информацией об алиасах ассоциаций
+    def association_aliases
+      @association_aliases || {}
+    end
+  end
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: alias_association
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Danil Pismenny
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+description: A Ruby on Rails concern that provides a simple way to create aliases
+  for ActiveRecord associations, including both getter and setter methods.
+email:
+- danil@brandymint.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- README.md
+- Rakefile
+- lib/alias_association.rb
+- lib/alias_association/alias_association_version.rb
+homepage: https://github.com/dapi/alias_association
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/dapi/alias_association
+  source_code_uri: https://github.com/dapi/alias_association
+  changelog_uri: https://github.com/dapi/alias_association/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.7.2
+specification_version: 4
+summary: ActiveRecord concern for creating aliases for associations
+test_files: []