simple_active_link_to 1.0.1 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2fc2f2a0baac9582848c238f5bbfb336d0829226b53f24fe50c3ed59e70ac5b
-  data.tar.gz: 197483dc1ed0902110ed3549379db959e300850548becdf3eecc8fd29d824a32
+  metadata.gz: c76b72044a585437ad07175a7aa395a970e25b8e402f04c5f1d585095060bc0d
+  data.tar.gz: 6495b87a880ac9bd383fac9c9db1f9a334468d1c5d37367689ced0890c644f46
 SHA512:
-  metadata.gz: 481c153155351ffd7f0344d62e800913383d3fe58499baea5a016008d3ba1d49543148ab9a9040953d1ff92bc3bd988b7580a16c9dd4a5f1fa7824852368d470
-  data.tar.gz: 6442363c9c5a5f0c872886ab8eb24fcb4ab34db9950bfd604a08edc58a891dfe8d836d47b875ac31f7be89529e9befc56f287e2f4c601a808101373d54d233c6
+  metadata.gz: bd65c905895aeabfbcbcecc6ad22cb091f164ae294d9801f91d2361f8f5b4f6b4898bcebb29ab6adc1cfcfc6ed29bc7d8de83144165d3b22f698dcb8fd08b316
+  data.tar.gz: a8b95ad3bed8c8892523c46df3f66fee9738e3709c4ecbe9f7478f358b9e34db2de1eee2dd58e227b781b7ed0a27a1c09d2bf55922583af2e5b5ade9cf951359

data/.github/workflows/build.yml

@@ -0,0 +1,33 @@
+name: Build
+
+on:
+  push:
+    branches: [ master, dev ]
+    paths-ignore:
+      - "**/README.md"
+      - lib/simple_active_link_to/version.rb
+  pull_request:
+    branches: [ master, dev ]
+    paths-ignore:
+      - "**/README.md"
+      - lib/simple_active_link_to/version.rb
+
+jobs:
+  tests:
+    name: Tests
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [2.5, 2.6, 2.7, 3.0]
+        rails: ['5.0', '5.1', '5.2', '6.0', '6.1']
+    env:
+      BUNDLE_PATH: vendor/bundle
+      BUNDLE_GEMFILE: test/gemfiles/${{ matrix.rails }}.gemfile
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - run: bundle exec rake

data/.gitignore

@@ -1,2 +1,6 @@
+.bundle
+
 .DS_Store
 Gemfile.lock
+
+test/gemfiles/*.gemfile.lock

data/Gemfile

@@ -1,10 +1,3 @@
 source 'http://rubygems.org'
 
 gemspec
-
-group :test do
-  gem 'minitest'
-  gem 'rake'
-  gem 'rack-test'
-  gem 'nokogiri'
-end

data/README.md

@@ -1,23 +1,18 @@
-# simple_active_link_to
+# simple_active_link_to ![Build](https://github.com/frullah/simple_active_link_to/workflows/Build/badge.svg) [![Gem Version](https://img.shields.io/gem/v/simple_active_link_to.svg?style=flat)](http://rubygems.org/gems/simple_active_link_to)
 
-Creates a link tag of the given name using a URL created by the set of options. Please see documentation for [link_to](http://api.rubyonrails.org/classes/ActionView/Helpers/UrlHelper.html#method-i-link_to), `simple_active_link_to` is basically a wrapper for it. This method accepts an optional :active parameter that dictates if the given link will have an extra css class attached that marks it as 'active'.
+`simple_active_link_to` is a wrapper for [link_to](http://api.rubyonrails.org/classes/ActionView/Helpers/UrlHelper.html#method-i-link_to), with active state by adding an extra css class `active` by default.
 
-[![Gem Version](https://img.shields.io/gem/v/simple_active_link_to.svg?style=flat)](http://rubygems.org/gems/simple_active_link_to)
-[![Gem Downloads](https://img.shields.io/gem/dt/simple_active_link_to.svg?style=flat)](http://rubygems.org/gems/simple_active_link_to)
-[![Build Status](https://img.shields.io/travis/comfy/simple_active_link_to.svg?style=flat)](https://travis-ci.org/comfy/simple_active_link_to)
-[![Gitter](https://badges.gitter.im/comfy/comfortable-mexican-sofa.svg)](https://gitter.im/comfy/comfortable-mexican-sofa)
+This gem works like [active_link_to](https://github.com/comfy/active_link_to), but with additional ```active_disable``` option and without wrap tag.
 
-support ruby >= 2.4
+Tested with ruby 2.5 to 3.0 and rails 5.0 to 6.1
 
 ## Installation
 add `gem 'simple_active_link_to'` to Gemfile and run `bundle install`.
 
-or using `bundle add` command
+or if you want to add with bundle command
 
 `bundle add simple_active_link_to`
 
-For older Rails apps add `config.gem 'simple_active_link_to'` in config/environment.rb and run `rake gems:install`. Or just checkout this repo into /vendor/plugins directory.
-
 ## Super Simple Example
 Here's a link that will have a class attached if it happens to be rendered
 on page with path `/users` or any child of that page, like `/users/123`
@@ -127,6 +122,13 @@ simple_active_link_to 'Users', users_path, active_disable: true
 # => <span class="active">Users</span>
 ```
 
+or you want to append it with hash (`#`) at the end of url to make the link does not reload the page when clicked
+
+```ruby
+simple_active_link_to 'Users', users_path, active_disable: :hash
+# => <a href="/users#" class="active">Users</a>
+```
+
 ## Helper Methods
 You may directly use methods that `simple_active_link_to` relies on.
 
@@ -143,7 +145,3 @@ is_active_link?(users_path, :inclusive)
 active_link_to_class(users_path, active: :inclusive)
 # => 'active'
 ```
-
-### Copyright
-
-Copyright (c) 2009-18 Oleg Khabarov. See LICENSE for details.

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rubygems'
 require 'rake/testtask'
 require 'bundler/setup'

data/lib/simple_active_link_to.rb

@@ -1,3 +1,5 @@
-require 'addressable/uri'
+# frozen_string_literal: true
+
+require 'active_support/core_ext/uri'
 require 'simple_active_link_to/simple_active_link_to'
 require 'simple_active_link_to/version'

data/lib/simple_active_link_to/simple_active_link_to.rb

@@ -1,42 +1,55 @@
+# frozen_string_literal: true
+
 module SimpleActiveLinkTo
+  ACTIVE_OPTIONS = %i[
+    active
+    class_active
+    class_inactive
+    active_disable
+  ].freeze
+
   # Wrapper around link_to. Accepts following params:
   #   :active         => Boolean | Symbol | Regex | Controller/Action Pair
   #   :class_active   => String
   #   :class_inactive => String
-  #   :active_disable => Boolean
-  #   :wrap_tag       => Symbol
+  #   :active_disable => Boolean | :hash
   # Example usage:
   #   simple_active_link_to('/users', class_active: 'enabled')
-  #   simple_active_link_to(users_path, active: :exclusive, wrap_tag: :li)
-  def simple_active_link_to(*args, &block)
-    name = block_given? ? capture(&block) : args.shift
-    options = args.shift || {}
-    html_options = args.shift || {}
-
-    url = url_for(options)
+  def simple_active_link_to(name = nil, options = nil, html_options = nil, &block)
+    if block_given?
+      html_options = options
+      options = name
+      name = capture(&block)
+    end
 
-    active_options = {}
+    html_options ||= {}
     link_options = {}
+    active_options = {}
     html_options.each do |k, v|
-      if %i[active class_active class_inactive active_disable].member?(k)
+      if ACTIVE_OPTIONS.include?(k)
         active_options[k] = v
       else
         link_options[k] = v
       end
     end
 
-    css_class = "#{link_options.delete(:class)} #{active_link_to_class(url, active_options)}"
-    css_class.strip!
-    link_options[:class] = css_class if css_class != ''
+    url = url_for(options)
 
-    is_active = is_active_link?(url, active_options[:active])
-    link_options[:'aria-current'] = 'page' if is_active
+    css_class = link_options[:class]
+    active_class = active_link_to_class(url, active_options)
+    link_options[:class] = "#{css_class} #{active_class}".strip
 
-    if active_options[:active_disable] == true && is_active
-      content_tag(:span, name, link_options)
-    else
-      link_to(name, url, link_options)
+    if is_active_link?(url, active_options[:active])
+      link_options[:'aria-current'] = 'page'
+      case active_options[:active_disable]
+      when true
+        return content_tag(:span, name, link_options) 
+      when :hash
+        url += "#"
+      end
     end
+
+    link_to(name, url, link_options)
   end
 
   # Returns css class name. Takes the link's URL and its params
@@ -68,30 +81,34 @@ module SimpleActiveLinkTo
   def is_active_link?(url, condition = nil)
     @is_active_link ||= {}
     @is_active_link[[url, condition]] ||= begin
-      original_url = url
-      url = Addressable::URI.parse(url).path
-      path = request.original_fullpath
       case condition
-      when :inclusive, nil
-        path.match?(%r{^#{Regexp.escape(url).chomp('/')}(/.*|\?.*)?$})
-      when :exclusive
-        path.match?(%r{^#{Regexp.escape(url)}/?(\?.*)?$})
+      when :exclusive, :inclusive, nil
+        url_path = url.split('#').first.split('?').first
+        url_string = URI::DEFAULT_PARSER.unescape(url_path).force_encoding(Encoding::BINARY)
+        request_uri = URI::DEFAULT_PARSER.unescape(request.path).force_encoding(Encoding::BINARY)
+
+        if url_string == request_uri
+          true
+        elsif condition != :exclusive
+          closing = url_string.end_with?('/') ? '' : '/'
+          request_uri.start_with?(url_string + closing)
+        else
+          false
+        end
       when :exact
-        path == original_url
+        request.original_fullpath == url
       when Regexp
-        path.match?(condition)
+        request.original_fullpath.match?(condition)
       when Array
-        controllers = [*condition[0]]
-        actions     = [*condition[1]]
+        controllers = Array(condition[0])
+        actions     = Array(condition[1])
         (controllers.blank? || controllers.member?(params[:controller])) &&
           (actions.blank? || actions.member?(params[:action])) ||
           controllers.any? do |controller, action|
             params[:controller] == controller.to_s && params[:action] == action.to_s
           end
-      when TrueClass
-        true
-      when FalseClass
-        false
+      when TrueClass, FalseClass
+        condition
       when Hash
         condition.all? do |key, value|
           params[key].to_s == value.to_s

data/lib/simple_active_link_to/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SimpleActiveLinkTo
-  VERSION = "1.0.1"
+  VERSION = "1.1.1"
 end

data/simple_active_link_to.gemspec

@@ -1,22 +1,26 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
-$:.unshift File.expand_path('../lib', __FILE__)
+$:.unshift File.expand_path('lib', __dir__)
 require 'simple_active_link_to/version'
 
 Gem::Specification.new do |s|
-  s.name          = "simple_active_link_to"
+  s.name          = 'simple_active_link_to'
   s.version       = SimpleActiveLinkTo::VERSION
-  s.authors       = ["Fajarullah"]
-  s.email         = ["frullah12@gmail.com"]
-  s.homepage      = "http://github.com/frullah/simple_active_link_to"
-  s.summary       = "ActionView helper to render currently active links"
-  s.description   = "Helpful method when you need to add some logic that figures out if the link (or more often navigation item) is selected based on the current page or other arbitrary condition"
-  s.license       = "MIT"
+  s.authors       = ['Fajarullah']
+  s.email         = ['frullah12@gmail.com']
+  s.homepage      = 'http://github.com/frullah/simple_active_link_to'
+  s.summary       = 'ActionView helper to render currently active links'
+  s.description   = 'Helpful method when you need to add some logic that figures out if the link (or more often navigation item) is selected based on the current page or other arbitrary condition'
+  s.license       = 'MIT'
 
   s.files         = `git ls-files`.split("\n")
 
-  s.required_ruby_version = ">= 2.4.0"
+  s.required_ruby_version = '>= 2.4.0'
+  s.add_development_dependency 'minitest'
+  s.add_development_dependency 'nokogiri'
+  s.add_development_dependency 'rack-test'
+  s.add_development_dependency 'rake'
 
-  s.add_dependency 'actionpack'
-  s.add_dependency 'addressable'
+  s.add_dependency 'actionpack', '>= 5.0'
+  s.add_dependency 'activesupport', '>= 5.0'
 end

data/test/gemfiles/5.0.gemfile

@@ -3,10 +3,3 @@ source 'http://rubygems.org'
 gemspec path: "../../"
 
 gem "actionpack", "~> 5.0.0"
-
-group :test do
-  gem 'minitest'
-  gem 'rake'
-  gem 'rack-test'
-  gem 'nokogiri'
-end

data/test/gemfiles/5.1.gemfile

@@ -3,10 +3,3 @@ source 'http://rubygems.org'
 gemspec path: "../../"
 
 gem "actionpack", "~> 5.1.0"
-
-group :test do
-  gem 'minitest'
-  gem 'rake'
-  gem 'rack-test'
-  gem 'nokogiri'
-end

data/test/gemfiles/5.2.gemfile

@@ -3,10 +3,3 @@ source 'http://rubygems.org'
 gemspec path: "../../"
 
 gem "actionpack", "~> 5.2.0"
-
-group :test do
-  gem 'minitest'
-  gem 'rake'
-  gem 'rack-test'
-  gem 'nokogiri'
-end

data/test/gemfiles/6.0.gemfile

@@ -0,0 +1,5 @@
+source 'http://rubygems.org'
+
+gemspec path: "../../"
+
+gem "actionpack", "~> 6.0.0"

data/test/gemfiles/6.1.gemfile

@@ -0,0 +1,5 @@
+source 'http://rubygems.org'
+
+gemspec path: "../../"
+
+gem "actionpack", "~> 6.1.0"

data/test/simple_active_link_to_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'test_helper'
 
 class SimpleActiveLinkToTest < MiniTest::Test
@@ -7,6 +9,10 @@ class SimpleActiveLinkToTest < MiniTest::Test
     refute is_active_link?('/', false)
   end
 
+  def test_is_active_link_handle_empty_string
+    assert is_active_link?('', true)
+  end
+
   def test_is_active_link_symbol_inclusive
     set_path('/root')
     assert is_active_link?('/root', :inclusive)
@@ -184,12 +190,18 @@ class SimpleActiveLinkToTest < MiniTest::Test
     assert_html link, 'a.off[href="/other"]', 'label'
   end
 
-  def test_active_link_to_with_active_disable
+  def test_active_link_to_with_active_disable_as_true
     set_path('/root')
     link = simple_active_link_to('label', '/root', active_disable: true)
     assert_html link, 'span.active', 'label'
   end
 
+  def test_active_link_to_with_active_disable_as_hash
+    set_path('/root')
+    link = simple_active_link_to('label', '/root', active_disable: :hash)
+    assert_html link, 'a.active[href="/root#"]', 'label'
+  end
+
   def test_should_not_modify_passed_params
     set_path('/root')
     params = {class: 'testing', active: :inclusive}
@@ -209,4 +221,10 @@ class SimpleActiveLinkToTest < MiniTest::Test
     link = simple_active_link_to('label', '/äöü')
     assert_html link, 'a.active[href="/äöü"]', 'label'
   end
+
+  def test_active_link_to_with_block
+    set_path('/root')
+    link = simple_active_link_to('/root') { 'label' }
+    assert_html link, 'a.active[href="/root"]', 'label'
+  end
 end

data/test/test_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/setup'
 require 'minitest/autorun'
 require 'uri'
@@ -5,21 +7,35 @@ require 'action_view'
 require 'simple_active_link_to'
 
 class MiniTest::Test
-
   # need this to simulate requests that drive active_link_helper
   module FakeRequest
     class Request
       attr_accessor :original_fullpath
+
+      def path
+        return original_fullpath unless original_fullpath&.include?('?')
+
+        @path ||= original_fullpath.split('?').first
+      end
     end
+
     def request
       @request ||= Request.new
     end
+
     def params
       @params ||= {}
     end
   end
 
-  SimpleActiveLinkTo.send :include, FakeRequest
+  module FakeCapture
+    def capture
+      yield
+    end
+  end
+
+  SimpleActiveLinkTo.include FakeRequest
+  SimpleActiveLinkTo.include FakeCapture
 
   include ActionView::Helpers::UrlHelper
   include ActionView::Helpers::TagHelper
@@ -27,9 +43,7 @@ class MiniTest::Test
 
   def set_path(path, purge_cache = true)
     request.original_fullpath = path
-    if purge_cache && defined?(@is_active_link)
-      remove_instance_variable(:@is_active_link)
-    end
+    remove_instance_variable(:@is_active_link) if purge_cache && defined?(@is_active_link)
   end
 
   def assert_html(html, selector, value = nil)

metadata

@@ -1,23 +1,23 @@
 --- !ruby/object:Gem::Specification
 name: simple_active_link_to
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.1
 platform: ruby
 authors:
 - Fajarullah
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-19 00:00:00.000000000 Z
+date: 2021-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: actionpack
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -25,19 +25,75 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: addressable
+  name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
 description: Helpful method when you need to add some logic that figures out if the
   link (or more often navigation item) is selected based on the current page or other
   arbitrary condition
@@ -47,8 +103,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/build.yml"
 - ".gitignore"
-- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
@@ -56,11 +112,12 @@ files:
 - lib/simple_active_link_to.rb
 - lib/simple_active_link_to/simple_active_link_to.rb
 - lib/simple_active_link_to/version.rb
-- simple_active_link_to-1.0.0.gem
 - simple_active_link_to.gemspec
 - test/gemfiles/5.0.gemfile
 - test/gemfiles/5.1.gemfile
 - test/gemfiles/5.2.gemfile
+- test/gemfiles/6.0.gemfile
+- test/gemfiles/6.1.gemfile
 - test/simple_active_link_to_test.rb
 - test/test_helper.rb
 homepage: http://github.com/frullah/simple_active_link_to
@@ -82,7 +139,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: ActionView helper to render currently active links

data/.travis.yml

@@ -1,16 +0,0 @@
-language: ruby
-rvm:
-  - 2.3.7
-  - 2.4.4
-  - 2.5.1
-  - ruby-head
-gemfile:
-  - test/gemfiles/5.0.gemfile
-  - test/gemfiles/5.1.gemfile
-  - test/gemfiles/5.2.gemfile
-before_install:
-  - gem update --system
-  - gem update bundler
-matrix:
-  allow_failures:
-    - rvm: ruby-head