phcdevworks_active_menus 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 63f3b236375801e45029266d77490ac7af914fafcfd9b4059f1e814252f14ba2
+  data.tar.gz: 992c06187f7a2388b63f50fca8b30fa27ba971cf29278ee18d3298bf3965ec25
+SHA512:
+  metadata.gz: fbc91395db1e180ed9e1653550f956edf944caaa58d11483f6f5acb73aaedf22c712cab8e2c8f5e21a85de3809b55c39b9c5b5281eaf553a2320158515618e60
+  data.tar.gz: 8bb277515e8de6972e57af118b826a39bb9040680cea637ec182c8c0a4b1dcb80ae09441d1aa5d526340dd2ddab30257c0caf81f828bdac25148aaafdc46cc95

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 - PHCDEVWORKS
+
+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,31 @@
+### PHCDevworks Active Menus for Rails 6 (Add Active Class to Menus)
+PHCDevworks Active Menus Rails 6 engine with helpers to add active class to menus.
+
+* Add active class based on current controller.
+* Add active class based on current action.
+* Add active class based on both current controller plus current action.
+
+#### Step 1 - Add PHCDevworks Active Menus to your gemfile  
+
+	gem 'phcdevworks_active_menus'
+	bundle install
+
+#### Step 2 - Load Helpers in the Application's Controller  
+Add the line of code below into your app/controllers/application_controller.rb (application's controller file).  
+
+	helper PhcdevworksActiveMenus::Engine.helpers
+
+#### How to Add Active Class Based on Controller Only (Often used for main menu items with sub-menus.)  
+Add the line of code in between <div class""> tag.
+
+    <%= phc_menu_active_controller("ExampleControllerName") %>  
+
+#### How to Add Active Class Based on Action Only (Often used for submenu items.)  
+Add the line of code in between <div class""> tag.
+  
+    <%= phc_menu_active_action("ExampleActionName") %>  
+
+#### How to Add Active Class Based on Action Only (Used if you need to get specific.)  
+Add the line of code in between <div class""> tag.
+  
+    <%= phc_menu_active_action_controller("ExampleControllerName", "ExampleActionName") %>  

data/Rakefile

@@ -0,0 +1,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'PhcdevworksActiveMenus'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("test/test_app/Rakefile", __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+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/app/assets/config/phcdevworks_active_menus_manifest.js

@@ -0,0 +1,3 @@
+//= link_tree ../images
+//= link_directory ../javascripts/phcdevworks_active_menus .js
+//= link_directory ../stylesheets/phcdevworks_active_menus .scss

data/app/controllers/phcdevworks_active_menus/application_controller.rb

@@ -0,0 +1,5 @@
+module PhcdevworksActiveMenus
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+  end
+end

data/app/helpers/phcdevworks_active_menus/application_helper.rb

@@ -0,0 +1,20 @@
+module PhcdevworksActiveMenus
+  module ApplicationHelper
+  
+    # Add Active to Menu Based on Controller Name
+    def phc_menu_active_controller(controller_name)
+      params[:controller] == controller_name ? "active" : nil
+    end
+
+    # Add Active to Menu Based on Controller Name
+    def phc_menu_active_action(action_name)
+      params[:action] == action_name ? "active" : nil
+    end
+
+    # Add Active to Menu Based on Both Controller Name and Action
+    def phc_menu_active_action_controller(controller_name, action_name)
+      params[:controller] == controller_name && params[:action] == action_name ? "active" : nil
+    end
+
+  end
+end

data/app/jobs/phcdevworks_active_menus/application_job.rb

@@ -0,0 +1,4 @@
+module PhcdevworksActiveMenus
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/phcdevworks_active_menus/application_mailer.rb

@@ -0,0 +1,6 @@
+module PhcdevworksActiveMenus
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/models/phcdevworks_active_menus/application_record.rb

@@ -0,0 +1,5 @@
+module PhcdevworksActiveMenus
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/views/layouts/phcdevworks_active_menus/application.html.erb

@@ -0,0 +1,18 @@
+<!DOCTYPE html>
+<html>
+<head>
+
+  <title>PHCDevworks Active Menus</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+  
+  <%= stylesheet_link_tag    "phcdevworks_active_menus/application", media: "all" %>
+  <%= javascript_include_tag "phcdevworks_active_menus/application" %>
+
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/lib/phcdevworks_active_menus.rb

@@ -0,0 +1,5 @@
+require "phcdevworks_active_menus/engine"
+
+module PhcdevworksActiveMenus
+  # Your code goes here...
+end

data/lib/phcdevworks_active_menus/engine.rb

@@ -0,0 +1,11 @@
+module PhcdevworksActiveMenus
+  class Engine < ::Rails::Engine
+
+    # Load Asset Dependencies
+    require "sassc-rails"
+
+    # Plugin Namespace
+    isolate_namespace PhcdevworksActiveMenus
+
+  end
+end

data/lib/phcdevworks_active_menus/version.rb

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

data/lib/tasks/phcdevworks_active_menus_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :phcdevworks_active_menus do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: phcdevworks_active_menus
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- PHCDevworks
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-05-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.0.rc1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.0.rc1
+- !ruby/object:Gem::Dependency
+  name: sassc-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Rails helpers to add active class to menu items based on controller and
+  controller action.
+email:
+- developers@phcdevworks.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/phcdevworks_active_menus_manifest.js
+- app/assets/javascripts/phcdevworks_active_menus/application.js
+- app/assets/stylesheets/phcdevworks_active_menus/application.scss
+- app/controllers/phcdevworks_active_menus/application_controller.rb
+- app/helpers/phcdevworks_active_menus/application_helper.rb
+- app/jobs/phcdevworks_active_menus/application_job.rb
+- app/mailers/phcdevworks_active_menus/application_mailer.rb
+- app/models/phcdevworks_active_menus/application_record.rb
+- app/views/layouts/phcdevworks_active_menus/application.html.erb
+- lib/phcdevworks_active_menus.rb
+- lib/phcdevworks_active_menus/engine.rb
+- lib/phcdevworks_active_menus/version.rb
+- lib/tasks/phcdevworks_active_menus_tasks.rake
+homepage: https://phcdevworks.com/
+licenses:
+- MIT
+metadata: {}
+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.0.3
+signing_key: 
+specification_version: 4
+summary: PHCDevworks - Helpers - Active Menus
+test_files: []