rails_url_shortener 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bada11c316875a094b6bb41ca076db3adc1b52bf277206cea1a910b4505974b3
-  data.tar.gz: 3ceae3dc8be6b256b83b196b6602ae65f07c6e17d885bf7eb0308127b4a18356
+  metadata.gz: d4cc011facb5faaf918c6259c775e13aa8554c0e2ddc4ae030cc5465c398ef81
+  data.tar.gz: 58419048c10c497c28ce6f774cd3925174acb547f6bc5561ed1213b61dd1e278
 SHA512:
-  metadata.gz: a9081dbc5d20f346df7e9f712a509f11e6e358a13e6309ced32a8f88ea6b3ebbde0e3ef0a702b1c1e39bfd11c441122b863d73f4dba7780e920e3ebf771f6bf5
-  data.tar.gz: 354c754d94b1cd677523d2f4bfde370722311b584fd041ee8a2272930d2df3c09a8e18f64501d12ed8aca4a833b2b302767fb20e1b85c402af06f64dc80bb215
+  metadata.gz: 63c1963fed3b1bbde71d922c1f1ce57911d51574c0d7c6d8be10a266fca176eb7ce1104935c10d3fee4b3a820a6ca8900ebe0c80686a75a5d8c8ccd46f911029
+  data.tar.gz: 0cf6f3ee876c3f24d486e7335a95e6160075626fe5e9ba250cdede81682960a743f973fae46e932867ff6077f170eb335a3f5518713d3685e0117be84325b1e4

data/README.md

@@ -25,46 +25,37 @@ Here are some of the things you can do with RailsUrlShortener:
 
 ## Installation
 
-Follow these steps to install and configure RailsUrlShortener:
+Follow these steps to install and configure rails_url_shortener in your Rails application.
 
-1. Add this line to your application's Gemfile:
+1. Add the Gem
+Add the following line to your application's Gemfile:
 
 ```ruby
 gem "rails_url_shortener"
 ```
-
-2. Install the gem by running:
+2. Install the Gem
+Run the following command to install the gem:
 
 ```bash
 bundle install
 ```
-
-3. Install and run the migrations:
-
-```bash
-bin/rails rails_url_shortener:install:migrations db:migrate
-```
-
-4. Generate the initializer for configuration:
-
+3. Run the Generator
+Run the generator to set up the necessary files:
 ```bash
 rails generate rails_url_shortener
 ```
+This will:
+✅ Install and run the required migrations
 
-## Usage
-
-1. Mount the engine
-
-Mount the engine on your app adding the next code on your config/routes.rb:
+✅ Mount the engine
+An entry will be added to the bottom of your config/routes.rb file, mounting the engine at the root of your application.
 
-**If you want to mount this on the root of your app, this should be on the bottom of your routes file.**
+✅ Generate an initializer for further configuration`
 
-```ruby
-mount RailsUrlShortener::Engine, at: "/"
 
-```
+## Usage
 
-2. Generate the short link
+1. Generate the short link
 
 And generate the short links like you want:
 
@@ -80,7 +71,7 @@ short_url("https://www.github.com/a-chacon/rails-url-shortener")
 RailsUrlShortener::Url.generate("https://www.github.com/a-chacon/rails-url-shortener")
 ```
 
-3. Share the short link
+2. Share the short link
 
 **Then share the short link to your users or wherever you want.**
 

data/app/models/rails_url_shortener/visit.rb

@@ -35,6 +35,8 @@ module RailsUrlShortener
     # Return boolean
     # rubocop:disable Metrics/AbcSize
     def self.parse_and_save(url, request)
+      return false unless RailsUrlShortener.save_visits
+
       browser(request)
       return false if !RailsUrlShortener.save_bots_visits && @browser.bot?
 

data/lib/generators/rails_url_shortener/rails_url_shortener_generator.rb

@@ -5,6 +5,22 @@ require 'rails/generators'
 class RailsUrlShortenerGenerator < Rails::Generators::Base
   source_root File.expand_path('templates', __dir__)
 
+  def install_and_run_migrations
+    if Rails.env.test?
+      puts 'Skipping migrations in test environment'
+    else
+      rake 'rails_url_shortener:install:migrations'
+      rake 'db:migrate'
+    end
+  end
+
+  def add_route_to_routes_file
+    # Mount the engine at the bottom of the routes file in the host application.
+    inject_into_file 'config/routes.rb', before: /\nend\s*\Z/ do
+      "\n  mount RailsUrlShortener::Engine, at: '/'"
+    end
+  end
+
   def copy
     copy_file 'initializer.rb', 'config/initializers/rails_url_shortener.rb'
   end

data/lib/generators/rails_url_shortener/templates/initializer.rb

@@ -12,3 +12,4 @@ RailsUrlShortener.charset = CHARSETS[:alphanumcase] # used for generate the keys
 RailsUrlShortener.key_length = 6                    # Key length for random generator
 RailsUrlShortener.minimum_key_length = 3            # minimum permited for a key
 RailsUrlShortener.save_bots_visits = false          # if save bots visits
+RailsUrlShortener.save_visits = true                # if save visits

data/lib/rails_url_shortener/model.rb

@@ -1,11 +1,11 @@
 module RailsUrlShortener
   module Model
-    # rubocop:disable Naming/PredicateName
+    # rubocop:disable Naming/PredicatePrefix
     def has_short_urls
       class_eval do
         has_many :urls, class_name: 'RailsUrlShortener::Url', as: 'owner'
       end
     end
-    # rubocop:enable Naming/PredicateName
+    # rubocop:enable Naming/PredicatePrefix
   end
 end

data/lib/rails_url_shortener/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RailsUrlShortener
-  VERSION = '0.4.0'
+  VERSION = '0.6.0'
 end

data/lib/rails_url_shortener.rb

@@ -40,6 +40,8 @@ module RailsUrlShortener
   # so if you put this configuration like false could lose some visits to your link
   # by default saving all requests
   mattr_accessor :save_bots_visits, default: true
+
+  mattr_accessor :save_visits, default: true
 end
 
 ActiveSupport.on_load(:active_record) do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: rails_url_shortener
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - a-chacon
 bindir: bin
 cert_chain: []
-date: 2025-05-08 00:00:00.000000000 Z
+date: 2025-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: browser
@@ -74,9 +74,9 @@ licenses:
 - GPL-3.0
 metadata:
   bug_tracker_uri: https://www.github.com/a-chacon/rails-url-shortener/issues
-  changelog_uri: https://www.github.com/a-chacon/rails-url-shortener/releases/tag/v0.4.0
+  changelog_uri: https://www.github.com/a-chacon/rails-url-shortener/releases/tag/v0.6.0
   documentation_uri: https://github.com/a-chacon/rails-url-shortener/blob/main/README.md
-  source_code_uri: https://github.com/a-chacon/rails-url-shortener/tree/v0.4.0
+  source_code_uri: https://github.com/a-chacon/rails-url-shortener/tree/v0.6.0
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths: