rails_namespace_path_helper 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d2c1f49a54fc2e5c045929ceab9a57c6ba050ee441963a46578e85cb2a9f15e0
+  data.tar.gz: 270b0d5b6dfa0a81f0e41f8ec3435faf040eac5a258e46e2c57e5f64a65e7dc3
+SHA512:
+  metadata.gz: 3aa9b78e0c183be8777050a82a49c26a0654d63bf6ed317f31b5351c5ba683dab6267353b16b6cb24dcef0d6b636b7e666fcf7effffde11b5e7d4eac97669b3b
+  data.tar.gz: 14a84e8ca20d53061d804c22b744d8a9cc79003bafb37922ae42bb28d3558fcfa9c71013d8c1070197fb507a773b95d1d5a5ba4b9254c075edaa044f2aa91177

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 BenenB
+
+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 @@
+## RailsNamespacePathHelper
+## An extension for namespaced controllers
+
+Namespacing is a common pattern in rails, however...
+
+Rails does not account for namespacing when looking for helpers on controllers
+  - Eg. for `Admin::TasksController`
+    - helpers are declared `admin_tasks_url` 
+    - however rails bolierplate expects `tasks_url` to be available
+
+This gem dynamically creates aliases for these methods so that nothing needs to be reconfigured
+
+### Usage
+
+To use simply call:
+  - `has_namespaced_paths` at the top of each controller with a namespace
+  - or `has_namespaced_path_plural` / `has_namespaced_path_singular` for only plural/singular paths
+
+
+Like this:
+```
+# in controllers/admin/tasks_controller.rb
+class Admin::TasksController < ApplicationController
+  has_namespaced_paths
+
+  ...
+
+end
+```
+### Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+  `$ bundle add rails_namespace_path_helper` 
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+  `$ gem install rails_namespace_path_helper` 
+
+
+### Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/benenb/rails_namespace_path_helper.
+
+### 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,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/config.ru

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "rubygems"
+require "bundler"
+
+Bundler.require :default, :development
+
+Combustion.initialize! :all
+run Combustion::Application

data/lib/rails_namespace_path_helper/railtie.rb

@@ -0,0 +1,12 @@
+require "rails/railtie"
+module RailsNamespacePathHelper
+  # with thanks to: 'Gary S. Weaver'
+  # https://stackoverflow.com/questions/11348332/how-can-i-extend-applicationcontroller-in-a-gem
+  class Railtie < Rails::Railtie
+    initializer "rails_namespace_path_helper.action_controller" do 
+      ActiveSupport.on_load(:action_controller) do
+        extend RailsNamespacePathHelper
+      end
+    end
+  end
+end

data/lib/rails_namespace_path_helper/version.rb

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

data/lib/rails_namespace_path_helper.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+require_relative "rails_namespace_path_helper/version"
+require_relative "rails_namespace_path_helper/railtie"
+
+module RailsNamespacePathHelper
+
+  # This helper dynamically creates aliases for helpers generated by rails
+  # eg. in Admin:TasksController, tasks_url becomes an alias for admin_tasks_url
+
+  # These helpers are declared locally on the controller to avoid conflicts 
+
+  def has_namespaced_paths
+
+    has_namespaced_path_singular
+    has_namespaced_path_plural
+  end
+
+  def has_namespaced_path_singular
+    # separate controller name from namespace
+    model,namespaces = *parse_class_name
+
+    ['url','path'].each do |tag|
+      helper = "#{model.singularize}_#{tag}"
+
+      # short circuit if conflict      
+      next unless ensure_methods_available(namespaces, helper)
+
+      # create aliases...
+      define_namespace_helpers(namespaces,helper)
+    end
+  end
+
+  def has_namespaced_path_plural
+    # separate controller name from namespace
+    model,namespaces = *parse_class_name
+
+    ['url','path'].each do |tag|
+      helper = "#{model.pluralize}_#{tag}"
+
+      # short circuit if conflict
+      next unless ensure_methods_available(namespaces, helper)
+
+      # create aliases...
+      define_namespace_helpers(namespaces,helper)
+    end
+  end
+
+  private
+  def parse_class_name
+    model = self.name.split("::")[-1].gsub(/(.*)Controller$/,'\1').downcase
+    namespaces = self.name.split("::")[0...-1].join("_").downcase
+    return [model,namespaces]
+  end
+
+  def ensure_methods_available namespaces,helper
+    # false if helper is not defined
+    self.new.respond_to?("#{namespaces}_#{helper}".to_sym) &&  
+    # false if alias is already defined AND can resolve properly
+    !(self.new.respond_to?("#{helper}".to_sym) && (self.new.send(helper) rescue false))
+  end
+
+  def define_namespace_helpers namespaces,helper
+      self.define_method(helper.to_sym) do 
+        self.send("#{namespaces}_#{helper}".to_sym)
+      end    
+  end
+
+end

data/sig/rails_namespace_path_helper.rbs

@@ -0,0 +1,4 @@
+module RailsNamespacePathHelper
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: rails_namespace_path_helper
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- BenenB
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-05-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  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: 
+email:
+- benenbruen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- LICENSE.txt
+- README.md
+- Rakefile
+- config.ru
+- lib/rails_namespace_path_helper.rb
+- lib/rails_namespace_path_helper/railtie.rb
+- lib/rails_namespace_path_helper/version.rb
+- sig/rails_namespace_path_helper.rbs
+homepage: https://github.com/BenenB/rails_namespace_path_helper
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/BenenB/rails_namespace_path_helper
+  source_code_uri: https://github.com/BenenB/rails_namespace_path_helper
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.3
+signing_key: 
+specification_version: 4
+summary: An extension for namespaced controllers in Rails
+test_files: []