active_record_associations_module_name 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b05545848d718d6257c4cec922cae8d0a527d87f57d4a85d9a016ed1ff3b81f7
+  data.tar.gz: bd5192641fc352ae5667b48441cf291c851bdb2468db53a09f6a8781df4ebece
+SHA512:
+  metadata.gz: 4bd1f0a9292ace7ab88660ba5a2efeb1841a31fe98a80e1d577a7a6cd192a1d2dad55403021425e560fde0207a44b9f05988c5d83cbf1ca6a66b21cf4847deb2
+  data.tar.gz: b4b7bfb0559594efe9f06d14d29224e22b4a13e6675257792a3ab570f6f2e6b6f12d6c5ba4ebb27953ecdbaac44d40dde025e204c2ec8e189a825c3a32a1adc1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2021 Rafe Rosen
+
+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,47 @@
+# ActiveRecordAssociationsModuleName
+When working with ActiveRecord models within modules, retyping the module path within association definitions can become of repetive and noisy. This extension DRYs things up by adding a `module_name` option to ActiveRecord association definitions.
+
+## Usage
+Specify a string `module_name` for any ActiveRecord association (belongs_to, has_many, has_one, or has_and_belongs_to_many)
+
+For example:
+
+```ruby
+class Post
+  has_many :comments, module_name: "Blog"
+
+  # this replaces:
+  # has_many :comments, class_name: "Blog::Comment"
+end
+
+```
+
+Models often reference other models in the same module. For this you can use the shortcut `module_name: true`.
+
+```ruby
+class Blog::Post
+  has_many :comments, module_name: true
+
+  # this replaces:
+  # has_many :comments, class_name: "Blog::Comment"
+end
+
+```
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'active_record_associations_module_name'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+## Contributing
+Issues and pull requests are welcome. Please be respectful.
+
+## 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,14 @@
+require "bundler/setup"
+puts ENV["DATABASE_URL"]
+
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/active_record_associations_module_name.rb

@@ -0,0 +1,73 @@
+require "active_record_associations_module_name/version"
+
+# When working with ActiveRecord models within modules, retyping the module
+# path within association definitions becomes repetitive. These extensions add a
+# module_name option to AR-associations. You can specify a string that will
+# be prepended to the definition's class_name option, or you can just say
+# true to use the caller's module.
+#
+# Example:
+#
+# class Blog::Post
+#   has_many :comments, module_name: true
+#
+#   # this replaces:
+#   # has_many :comments, class_name: "Blog::Comment"
+# end
+#
+module ActiveRecordAssociationsModuleName
+  module AssociationClassMethodExtension
+    def belongs_to(name, scope = nil, **options)
+      options = process_module_name_option(name, options)
+      super(name, scope, **options)
+    end
+
+    def has_one(name, scope = nil, **options)
+      options = process_module_name_option(name, options)
+      super(name, scope, **options)
+    end
+
+    def has_many(name, scope = nil, **options)
+      options = process_module_name_option(name, options)
+      super(name, scope, **options)
+    end
+
+    def has_and_belongs_to_many(name, scope = nil, **options)
+      options = process_module_name_option(name, options)
+      super(name, scope, **options)
+    end
+
+    private def process_module_name_option name, options
+      if options[:class_name] && options[:module_name]
+        raise ArgumentError, "Options `module_name` and `class_name` are incompatible. Please specify only one."
+      elsif !options[:module_name]
+        return options
+      end
+
+      module_name = options.delete(:module_name)
+      class_name = name.to_s.singularize.camelize
+      case module_name
+      when true
+        module_prefix = to_s.split("::")[0..-2].join("::")
+      when String
+        module_prefix = module_name
+      else
+        raise ArgumentError, "Option module_name must be either a String or `true`."
+      end
+
+      options[:class_name] = [module_prefix, class_name].reject(&:blank?).join("::")
+      options
+    end
+  end
+  ActiveRecord::Associations::ClassMethods.prepend(ActiveRecordAssociationsModuleName::AssociationClassMethodExtension)
+
+  module ActiveRecordAssociationsModuleName::BuilderExtension
+    def valid_options(options)
+      super.push(:module_name)
+    end
+  end
+  ActiveRecord::Associations::Builder::Association.singleton_class.prepend(ActiveRecordAssociationsModuleName::BuilderExtension)
+end
+
+
+

data/lib/active_record_associations_module_name/version.rb

@@ -0,0 +1,3 @@
+module ActiveRecordAssociationsModuleName
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: active_record_associations_module_name
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rafe Rosen
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-05-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+description:
+email:
+- rafe@existentialmutt.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/active_record_associations_module_name.rb
+- lib/active_record_associations_module_name/version.rb
+homepage: http://github.com/existentialmutt/active_record_associations_module_name
+licenses:
+- MIT
+metadata:
+  homepage_uri: http://github.com/existentialmutt/active_record_associations_module_name
+  source_code_uri: http://github.com/existentialmutt/active_record_associations_module_name
+  changelog_uri: http://github.com/existentialmutt/active_record_associations_module_name/releases
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '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: Provides a `module_name` option for ActiveRecord Associations
+test_files: []