rails_controller_action_name_helpers 0.1.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: de1e3707f8850daf26fecc93752897711e22e332e2115782f22e9aa9f010f841
+  data.tar.gz: 66965ac9c83b22c2dfaea7554abe694c923e375693193bc923508ffdee8c110d
+SHA512:
+  metadata.gz: 852b4f24e2d649a6f8f74c099d73735b228d49d407746f35107c258e31f1a1db5708184e56f94ef3a035babe772a0c1c1dabc4c1e6ef7303c770d3f2ce1a6950
+  data.tar.gz: b153b6970dae418628eab4f101151737c09046106e4c8c483053a2f5f0ed5cc192ba665e64c92aeff4afbce87a5a53dc6bde198c6da42a949050b238bbec138a

checksums.yaml.gz.sig

@@ -0,0 +1,3 @@
+w�
����˿U��!	s�c�T?�?	*�suD���,d�S�"Ni:�k9���J�����s�)lB�
+��ǫ��K'sض�3
��6-�L�)4��+�;���+_
+*]�ћt/�<Vw�C����Ag5�N=�Y�9��A��p���ڹ�^�)�����2�/����)�Ī

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Kaspar Vollenweider
+
+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,16 @@
+# Rails Controller Action Name Helpers
+
+[Repository - casaper/rails_controller_action_name_helpers](https://github.com/casaper/rails_controller_action_name_helpers)  
+[Documentation](https://casaper.github.io/rails_controller_action_name_helpers/)
+
+Simple view helpers to have more readable checks for current controller name or action name.
+
+```haml
+- # this condition here
+- if action_name == 'index' && (controller_name == 'members' || controller_name == 'users')
+  %p This will only show if the partial is run on the index action on the members or users controller
+- # can be done like this
+- if ca_index?(:members, :users)
+  %p This will only show if the partial is run on the index action on the members or users controller
+```
+

data/Rakefile

@@ -0,0 +1,7 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+Bundler::GemHelper.install_tasks

data/app/helpers/controller_acttion_name_helpers.rb

@@ -0,0 +1,206 @@
+## Controller Action Name Helpers
+#
+# Simple view helpers to determine current action and controller name in
+# a more readable manner within Rails views.
+module ControllerActionNameHelpers
+  ## Current controller name is in name or multiple names
+  #
+  # @example current controller_name is users
+  #   controller?(:users)
+  # @example current controller_name is in list
+  #   controller?(:users, 'members')
+  # @example use with an array of symbols
+  #   controller?(*%i[users members guests])
+  # @overload controller?(controller_name)
+  #   @param controller_name [Symbol,String] a controller name
+  # @overload controller?(controller_name1, controller_name2)
+  #   @param controller_name1 [Symbol,String] a controller name
+  #   @param controller_name2 [Symbol,String] a controller name
+  #   @note takes unlimited amount of controller names.
+  # @return [Boolean] the controller name is in list
+  def controller?(*controller_names)
+    controller_names.map(&:to_s).include?(controller_name)
+  end
+  alias controller_name? controller?
+  alias controller_in? controller?
+  alias controller_name_in? controller?
+
+  ## Current action name is in name or multiple names
+  #
+  # @example current action is index
+  #   action?(:index)
+  # @example current action is index or show
+  #   action?('index', :show)
+  # @example use with an array of strings
+  #   action?(*%w[index show custom])
+  # @overload action?(action_name)
+  #   @param action_name [Symbol,String] a action name
+  # @overload action?(action_name1, action_name2)
+  #   @param action_name1 [Symbol,String] a action name
+  #   @param action_name2 [Symbol,String] a action name
+  #   @note takes unlimited amount of action names.
+  # @return [Boolean] the action name is in action_names
+  def action?(*action_names)
+    action_names.map(&:to_s).include?(action_name)
+  end
+  alias action_name? action?
+  alias action_in? action?
+  alias action_name_in? action?
+
+  ## Current action and controller name in lists
+  #
+  # @example action name in array and controller name in array
+  #   action_controller?(%w[index show custom], [:users, :members, 'guests'])
+  # @param action_names [Array(Symbol,String)] the action name list
+  # @param controller_names [Array(Symbol,String)] the controller name list
+  # @return [Bolean] the action and controller name match lists
+  def actions_controllers?(action_names, controller_names)
+    action?(*action_names) && controller?(*controller_names)
+  end
+
+  ## Controller of name and multiple actions
+  #
+  # @example controller users and new, create, edit or update
+  #   controller_actions?(:users, :new, :create, :edit, :update)
+  # @param contr_name [Symbol,String] the controllers name
+  # @param action_names [List(Symbol,String)] the action names to match
+  # @return [Boolean] the controller is name and actions in list
+  def controller_actions?(contr_name, *action_names)
+    controller_name == contr_name.to_s && action?(*action_names)
+  end
+
+  ## Action of name and mutliple controllers
+  #
+  # @example action is custom and controller in list
+  #   action_controllers?(:custom_action_name, :users, :members, :guests)
+  # @param act_name [Symbol,String] the controllers name
+  # @param controller_names [List(Symbol,String)] the action names to match
+  # @return [Boolean] the action is name and controllers in list
+  def action_controllers?(act_name, *controller_names)
+    action_name == act_name.to_s && controller?(*controller_names)
+  end
+
+  ## Current action name is index
+  #
+  def a_index?
+    action_name == 'index'
+  end
+  alias action_index? a_index?
+  alias action_name_index? a_index?
+
+  ## Current action name is show
+  #
+  def a_show?
+    action_name == 'show'
+  end
+  alias action_show? a_show?
+  alias action_name_show? a_show?
+
+  ## Current action name is new or create
+  #
+  # @note
+  #   Often controllers do `render :new` when there is errors in forms.
+  #   So it makes sense to be true when new or edit.
+  # @param without_create [Boolean] only new action
+  def a_new?(without_create = false)
+    if without_create
+      action_name == 'new'
+    else
+      action?(:new, :create)
+    end
+  end
+  alias action_new? a_new?
+  alias action_name_new? a_new?
+
+  ## Current action name is edit or update
+  #
+  # @note
+  #   Often controllers do `render :edit` when there is errors in forms.
+  #   So it makes sense to be true when new or edit.
+  # @param without_update [Boolean] only edit action
+  def a_edit?(without_update = false)
+    if without_update
+      action_name == 'edit'
+    else
+      action?(:edit, :update)
+    end
+  end
+  alias action_edit? a_edit?
+  alias action_name_edit? a_edit?
+
+  ## Current action name is index and controller name is in list
+  #
+  # @example current action is index and controller name is users
+  #   ca_index?('users')
+  # @example current action is index and controller name is in list
+  #   ca_index?(:users, :members)
+  # @overload ca_index?(controller_name)
+  #   @param controller_name [Symbol,String] a controller name
+  # @overload ca_index?(controller_name1, controller_name2)
+  #   @param controller_name1 [Symbol,String] a controller name
+  #   @param controller_name2 [Symbol,String] a controller name
+  #   @note takes unlimited amount of controller names.
+  # @return [Boolean] the controller name is in list
+  def ca_index?(*controller_names)
+    a_index? && controller?(*controller_names)
+  end
+  alias controller_index? ca_index?
+  alias controller_names_index? ca_index?
+
+  ## Current action name is show and controller name is in list
+  #
+  # @example current action is show and controller name is users
+  #   ca_show?('users')
+  # @example current action is show and controller name is in list
+  #   ca_show?(:users, :members)
+  # @overload ca_show?(controller_name)
+  #   @param controller_name [Symbol,String] a controller name
+  # @overload ca_show?(controller_name1, controller_name2)
+  #   @param controller_name1 [Symbol,String] a controller name
+  #   @param controller_name2 [Symbol,String] a controller name
+  #   @note takes unlimited amount of controller names.
+  # @return [Boolean] the controller name is in list
+  def ca_show?(*controller_names)
+    a_show? && controller?(*controller_names)
+  end
+  alias controller_names_show? ca_show?
+  alias controller_show? ca_show?
+
+  ## Current action name is new or create and controller name is in list
+  #
+  # @example current action is new or create and controller name is users
+  #   ca_new?('users')
+  # @example current action is new or create and controller name is in list
+  #   ca_new?(:users, :members)
+  # @overload ca_new?(controller_name)
+  #   @param controller_name [Symbol,String] a controller name
+  # @overload ca_new?(controller_name1, controller_name2)
+  #   @param controller_name1 [Symbol,String] a controller name
+  #   @param controller_name2 [Symbol,String] a controller name
+  #   @note takes unlimited amount of controller names.
+  # @return [Boolean] the controller name is in list
+  def ca_new?(*controller_names)
+    a_new? && controller?(*controller_names)
+  end
+  alias controller_names_new? ca_new?
+  alias controller_new? ca_new?
+
+  ## Current action name is edit or update and controller name is in list
+  #
+  # @example current action is edit or update and controller name is users
+  #   ca_edit?('users')
+  # @example current action is edit or update and controller name is in list
+  #   ca_edit?(:users, :members)
+  # @overload ca_edit?(controller_name)
+  #   @param controller_name [Symbol,String] a controller name
+  # @overload ca_edit?(controller_name1, controller_name2)
+  #   @param controller_name1 [Symbol,String] a controller name
+  #   @param controller_name2 [Symbol,String] a controller name
+  #   @note takes unlimited amount of controller names.
+  # @return [Boolean] the controller name is in list
+  def ca_edit?(*controller_names)
+    a_edit? && controller?(*controller_names)
+  end
+  alias controller_names_edit? ca_edit?
+  alias controller_edit? ca_edit?
+end

data/lib/rails_controller_action_name_helpers.rb

@@ -0,0 +1,7 @@
+require 'rails_controller_action_name_helpers/engine'
+
+module RailsControllerActionNameHelpers
+  def self.setup
+    yield self
+  end
+end

data/lib/rails_controller_action_name_helpers/engine.rb

@@ -0,0 +1,10 @@
+require 'rails'
+require File.expand_path('../../app/helpers/controller_acttion_name_helpers', __dir__)
+
+module RailsControllerActionNameHelpers
+  class Engine < Rails::Engine
+    initializer 'rails_controller_action_name_helpers.helper' do
+      ActionView::Base.include ControllerActionNameHelpers
+    end
+  end
+end

data/lib/rails_controller_action_name_helpers/version.rb

@@ -0,0 +1,3 @@
+module RailsControllerActionNameHelpers
+  VERSION = '0.1.4'.freeze
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: rails_controller_action_name_helpers
+version: !ruby/object:Gem::Version
+  version: 0.1.4
+platform: ruby
+authors:
+- Kaspar Vollenweider
+autorequire: 
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIEJDCCAoygAwIBAgIBATANBgkqhkiG9w0BAQsFADAeMRwwGgYDVQQDDBN2b2sv
+  REM9cGFudGVyL0RDPWNoMB4XDTIwMDMyMjEzMjkzNloXDTIxMDMyMjEzMjkzNlow
+  HjEcMBoGA1UEAwwTdm9rL0RDPXBhbnRlci9EQz1jaDCCAaIwDQYJKoZIhvcNAQEB
+  BQADggGPADCCAYoCggGBALGEZfAbnsIsRFm3ewtpMuEH0bQz9rh/m77aQ1mKMPi/
+  /NTsyUZ5UlwTC02kjIujHEju3wRhtnRZEC2u3uYlaFg+xyB9McQyp32+HeMGSuCI
+  6e9Pb4zKksyBd9cJwWGeCc0iJKgErXWsaGp0g38lJ9tqSFobkKhM+uW2ezsRzc7t
+  V3hA6u0H6zSOacXZIRSpHIizumc4/Klf2dowfaVGNonSsLBwFAMF3Hw+V4RMY3PK
+  p9ALhbA3qZ/7GB4y2npyj8csgwB2cQWo6ei61ZlXTQp8FZjX6tWGO8RhKqtzBkNn
+  G6Ap8MPDCwT8DeEv7gt1TTyzdDtyfEIpHoTdJup2bYrr2jPTPq1SkIsHKdFVhkCJ
+  s/hzGpW77kMaVGCJY/MmxMyzQUwdhbhYtKMpf2HrlU3HtX3n5S5Qc1t+WCRznisb
+  Hzr1wIGqBRhLM5zTJkDoW/kdGTJ888DUa56G+q3gNgh2EZlFU0F+gOXQ0w9wWMDA
+  v2dwHNA3n/Kuvtda1riEHQIDAQABo20wazAJBgNVHRMEAjAAMAsGA1UdDwQEAwIE
+  sDAdBgNVHQ4EFgQUw7jysEz3OgQDjaQiFTUqIVoisxgwGAYDVR0RBBEwD4ENdm9r
+  QHBhbnRlci5jaDAYBgNVHRIEETAPgQ12b2tAcGFudGVyLmNoMA0GCSqGSIb3DQEB
+  CwUAA4IBgQBSsoFVo795nkB3plaYMknXSYQYgDu3pIB9Q2zdEAXOHKJ/4HKfbWwL
+  YCDkriU1Qz3P9XAs0a6sbX5fSMDdpy37RGtIiTZc/YUtfLavSGNpQSzPiH1e+sx9
+  2th6KqY8pCGbSNvcxt4Fe6mnZBVvBggrSohUuiaQxQaS73vCLcTSqFJ5pvv2LbIi
+  WxKcAQ+94LY58LcbIRzSsr5seHcDkumKvCrvt/HsZ+saKjSiw7CqcTvn/ASpYRy6
+  m02uL0aINVjTShY+LvbTpmhXd3c1eiu3nTLrZ08hhRmsSryKjDS1ijgx89lHdiF4
+  aLGqcMJ4hVUkgyETYffOXqT2+45ZFnFiZnahedbqgocpbBKTi9DieFdd6d2NJ9yt
+  TCV3ppoMMaZvMdyWWd9rJS/+XbIv2Qh6S4pK3bt44Iw4OZzYXt9BlVzdBQ90KqVD
+  H8qKJCPtHNeEY1zTzVTIrUVDmsNhQN8QW14T233pMJVaNc7YLIt14k6yj6Hshr7b
+  H+0mfErZQ+o=
+  -----END CERTIFICATE-----
+date: 2020-03-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+description: Simple helpers to have more readable checks for current controller name
+  or action name in rails views.
+email:
+- vok@panter.ch
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- app/helpers/controller_acttion_name_helpers.rb
+- lib/rails_controller_action_name_helpers.rb
+- lib/rails_controller_action_name_helpers/engine.rb
+- lib/rails_controller_action_name_helpers/version.rb
+homepage: https://github.com/casaper/rails_controller_action_name_helpers
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Rails Controller Action Name Helpers
+test_files: []