shortener 0.8.2 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a65ebf87f18746199fa76ac0a91f3365d0c34b9c969f897c25422370a676355b
-  data.tar.gz: 8a06527bce6d9f10805d2a97525b04dc631ee1c9115cc3e016bb5263307269a3
+  metadata.gz: 9b5d472a9bc919a4d8908b8aed88d1118d2922d82a9cd8f93d99e955d10d00d7
+  data.tar.gz: 2c0668fd8dbf8583b412f5d3cb00e4b959ceb4b2ea8d73619c2404545b6cac58
 SHA512:
-  metadata.gz: 62ec7fe6fc1a26fd89804c967a00fffa9d7e9235ecb10d1b338dd188ca5f12bcf964ac983e2bac597b1a97a2b5195002060c81db280355701967a6d1b324bb60
-  data.tar.gz: 427b8118350ff106e97828caf7ce41433ae1dcc69d67c902e6e871555613e64bd4a5256709a22f3bf4d95c587cc96f43235bd38f6eb91cb17b454a24039337d8
+  metadata.gz: 22cb8aaee0f74c741adb61ccc5e8bda54b91a3f60d71c57f5e3adbc411be1fda02d5b1e5a7c71cdb44e5c8cf2fd312a2f9e1797823b296397fdf35ebd64c2be6
+  data.tar.gz: 6d364749841bc21a95299285f1e1c108068def18652d304495f034a155b2f2b262801e6c41d1fb9c573b11b57bebe983c91a4311802be2c8aac359e9d0f5ecb8

data/.github/workflows/ruby.yml

@@ -0,0 +1,64 @@
+name: Ruby
+
+on:
+  push:
+    branches: [ develop ]
+  pull_request:
+    branches: [ develop ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: true
+      matrix:
+        ruby-version: 
+          - '2.4'
+          - '2.7'
+          - '3.0'
+          - '3.2'
+        gemfile:
+          - rails_4.2.gemfile
+          - rails_5.2.gemfile
+          - rails_6.0.gemfile
+          - rails_6.1.gemfile
+          - rails_7.0.gemfile
+        include:
+          - ruby-version: '2.4'
+            gemfile: rails_4.2.gemfile
+            bundler-version: 1
+        exclude:
+        - ruby-version: '2.7'
+          gemfile: rails_4.2.gemfile
+        - ruby-version: '3.0'
+          gemfile: rails_4.2.gemfile
+        - ruby-version: '3.2'
+          gemfile: rails_4.2.gemfile
+        - ruby-version: '3.0'
+          gemfile: rails_5.2.gemfile
+        - ruby-version: '3.2'
+          gemfile: rails_5.2.gemfile
+        - ruby-version: '2.4'
+          gemfile: rails_6.0.gemfile
+        - ruby-version: '3.2'
+          gemfile: rails_6.0.gemfile
+        - ruby-version: '2.4'
+          gemfile: rails_6.1.gemfile
+        - ruby-version: '3.2'
+          gemfile: rails_6.1.gemfile
+        - ruby-version: '2.4'
+          gemfile: rails_7.0.gemfile
+
+    env:
+      BUNDLE_GEMFILE: ${{ github.workspace }}/gemfiles/${{ matrix.gemfile }}
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler: ${{ matrix.bundler-version }}
+        bundler-cache: true
+    - name: Run tests
+      run: bundle exec rake

data/.gitignore

@@ -11,6 +11,7 @@ bin/*
 *.gem
 *.swp
 Gemfile.lock
+.ruby-version
 .rvmrc
 .redcar/*
 gemfiles/*.lock

data/Appraisals

@@ -1,17 +1,9 @@
-appraise "rails_4" do
+appraise "rails_4.2" do
   gem "rails", "~> 4.2.10"
+  gem "rspec-rails", "~> 3.0"
   gem "sqlite3", "~> 1.3.6"
 end
 
-appraise "rails_5.0" do
-  gem "rails", "~> 5.0.7"
-  gem "sqlite3", "~> 1.3.6"
-end
-
-appraise "rails_5.1" do
-  gem "rails", "~> 5.1.6"
-end
-
 appraise "rails_5.2" do
   gem "rails", "~> 5.2.0"
 end
@@ -19,3 +11,11 @@ end
 appraise "rails_6.0" do
   gem "rails", "~> 6.0.0"
 end
+
+appraise "rails_6.1" do
+  gem "rails", "~> 6.1.0"
+end
+
+appraise "rails_7.0" do
+  gem "rails", "~> 7.0.0"
+end

data/README.rdoc

@@ -1,4 +1,4 @@
-{<img src="https://secure.travis-ci.org/jpmcgrath/shortener.svg?branch=master" alt="Build Status" />}[http://travis-ci.org/jpmcgrath/shortener]
+{<img src="https://github.com/jpmcgrath/shortener/actions/workflows/ruby.yml/badge.svg" alt="Build Status" />}[https://github.com/jpmcgrath/shortener/actions]
 {<img src="https://codeclimate.com/github/jpmcgrath/shortener/badges/gpa.svg" />}[https://codeclimate.com/github/jpmcgrath/shortener]
 {<img src="https://badge.fury.io/rb/shortener.svg" alt="Gem version" />}[http://badge.fury.io/rb/shortener]
 
@@ -65,7 +65,7 @@ migration:
 
 == Installation
 
-Shortener is compatible with Rails v3, v4, v5, & v6. To install, add to your Gemfile:
+Shortener is compatible with Rails v4, v5, & v6. To install, add to your Gemfile:
 
   gem 'shortener'
 
@@ -159,11 +159,11 @@ You can pass in your own key when generating a shortened URL. This should be uni
 You can create expirable URLs.
 Probably, most of the time it would be used with owner:
 
-  Shortener::ShortenedUrl.generate("example.com/page", user, expires_at: 24.hours.since)
+  Shortener::ShortenedUrl.generate("example.com/page", owner: user, expires_at: 24.hours.since)
 
-You can omit owner passing nil instead:
+You can omit owner:
 
-  Shortener::ShortenedUrl.generate("example.com/page", nil, expires_at: 24.hours.since)
+  Shortener::ShortenedUrl.generate("example.com/page", expires_at: 24.hours.since)
 
 === Fresh Links
 
@@ -256,26 +256,25 @@ If you want more things to happen when a user accesses one of your short urls, y
 
   *note:* If no shortened URL is found, the url will be `default_redirect` or `/`
 
-== Origins
+=== Configuring a different database for shortened_urls table
 
-For a bit of backstory to Shortener see this {blog post}[http://jamespmcgrath.com/a-simple-link-shortener-in-rails/].
+You can store a `shortened_urls` table in another database and connecting to it by creating a initializer with the following:
 
-== In The Wild
+```ruby
+ActiveSupport.on_load(:shortener_record) do
+  connects_to(database: { writing: :dbname, reading: :dbname_replica })
+end
+```
 
-Shortener is used in a number of production systems, including, but not limited to:
-
-- {Doorkeeper - An Event Management Tool}[http://www.doorkeeperhq.com/]
-- {1001tweets - Repost your tweets to get more clicks}[http://www.1001tweets.com/]
-- {NewsMaker.io - The curated newsletter builder}[https://www.newsmaker.io/]
-
-If you are using Shortener in your project and would like to be added to this list, please get in touch!
+**Note:** Please, replace `dbname` and `dbname_replica` to match your database configuration.
 
 == Contributing
 
 We welcome new contributors. Because we're all busy people, and because Shortener
 is used/relied upon by many projects, it is essential that new Pull Requests
 are opened with good spec coverage, and a passing build on supported ruby versions
-and Rails versions.
+and Rails versions. Please create a single PR per feature/contribution, with as
+few changes per PR as possible to make it easier to review.
 
 To contribute:
 

data/app/models/shortener/record.rb

@@ -0,0 +1,5 @@
+class Shortener::Record < ActiveRecord::Base #:nodoc:
+  self.abstract_class = true
+end
+
+ActiveSupport.run_load_hooks :shortener_record, Shortener::Record

data/app/models/shortener/shortened_url.rb

@@ -1,4 +1,4 @@
-class Shortener::ShortenedUrl < ActiveRecord::Base
+class Shortener::ShortenedUrl < Shortener::Record
 
   REGEX_LINK_HAS_PROTOCOL = Regexp.new('\Ahttp:\/\/|\Ahttps:\/\/', Regexp::IGNORECASE)
 
@@ -15,7 +15,7 @@ class Shortener::ShortenedUrl < ActiveRecord::Base
   end
 
   # exclude records in which expiration time is set and expiration time is greater than current time
-  scope :unexpired, -> { where(arel_table[:expires_at].eq(nil).or(arel_table[:expires_at].gt(::Time.current.to_s(:db)))) }
+  scope :unexpired, -> { where(arel_table[:expires_at].eq(nil).or(arel_table[:expires_at].gt(::Time.current))) }
 
   attr_accessor :custom_key
 

data/gemfiles/{rails_4.gemfile → rails_4.2.gemfile}

@@ -1,8 +1,9 @@
 # This file was generated by Appraisal
 
-source "http://rubygems.org"
+source "https://rubygems.org"
 
 gem "rails", "~> 4.2.10"
+gem "rspec-rails", "~> 3.0"
 gem "sqlite3", "~> 1.3.6"
 
 gemspec path: "../"

data/gemfiles/rails_5.2.gemfile

@@ -1,6 +1,6 @@
 # This file was generated by Appraisal
 
-source "http://rubygems.org"
+source "https://rubygems.org"
 
 gem "rails", "~> 5.2.0"
 

data/gemfiles/rails_6.0.gemfile

@@ -1,6 +1,6 @@
 # This file was generated by Appraisal
 
-source "http://rubygems.org"
+source "https://rubygems.org"
 
 gem "rails", "~> 6.0.0"
 

data/gemfiles/{rails_5.1.gemfile → rails_6.1.gemfile}

@@ -1,7 +1,7 @@
 # This file was generated by Appraisal
 
-source "http://rubygems.org"
+source "https://rubygems.org"
 
-gem "rails", "~> 5.1.6"
+gem "rails", "~> 6.1.0"
 
 gemspec path: "../"

data/gemfiles/rails_7.0.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 7.0.0"
+
+gemspec path: "../"

data/lib/shortener/engine.rb

@@ -1,5 +1,7 @@
+require "rack"
 require "rails/engine"
 require "voight_kampff"
+require "voight_kampff/rails"
 require "shortener"
 
 class Shortener::Engine < ::Rails::Engine #:nodoc:

data/lib/shortener/version.rb

@@ -1,3 +1,3 @@
 module Shortener
-  VERSION = '0.8.2'.freeze
+  VERSION = '1.0.1'.freeze
 end

data/lib/shortener.rb

@@ -1,4 +1,4 @@
-require "active_support/dependencies"
+require "active_support"
 
 module Shortener
 

data/shortener.gemspec

@@ -14,11 +14,11 @@ Gem::Specification.new do |s|
   s.homepage                  = "http://jamespmcgrath.com/projects/shortener"
   s.required_rubygems_version = "> 2.1.0"
 
-  s.add_dependency "voight_kampff", '~> 1.1.2'
+  s.add_dependency "voight_kampff", '~> 2.0'
 
   s.add_development_dependency "rails", '>= 3'
   s.add_development_dependency "sqlite3"
-  s.add_development_dependency "rspec-rails", '~> 3.6.0'
+  s.add_development_dependency "rspec-rails"
   s.add_development_dependency "shoulda-matchers"
   s.add_development_dependency "faker"
   s.add_development_dependency "byebug"

data/spec/spec_helper.rb

@@ -10,6 +10,7 @@ require 'faker'
 require 'capybara/rspec'
 
 Rails.backtrace_cleaner.remove_silencers!
+ActiveRecord::Base.logger = Logger.new(STDOUT) if ENV['LOG_STDOUT']
 
 Shoulda::Matchers.configure do |config|
   config.integrate do |with|

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: shortener
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 1.0.1
 platform: ruby
 authors:
 - James P. McGrath
 - Michael Reinsch
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-06 00:00:00.000000000 Z
+date: 2023-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: voight_kampff
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.2
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.2
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -57,16 +57,16 @@ dependencies:
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.6.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.6.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: shoulda-matchers
   requirement: !ruby/object:Gem::Requirement
@@ -148,8 +148,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
-- ".travis.yml"
 - Appraisals
 - Gemfile
 - MIT-LICENSE
@@ -157,12 +157,13 @@ files:
 - Rakefile
 - app/controllers/shortener/shortened_urls_controller.rb
 - app/helpers/shortener/shortener_helper.rb
+- app/models/shortener/record.rb
 - app/models/shortener/shortened_url.rb
-- gemfiles/rails_4.gemfile
-- gemfiles/rails_5.0.gemfile
-- gemfiles/rails_5.1.gemfile
+- gemfiles/rails_4.2.gemfile
 - gemfiles/rails_5.2.gemfile
 - gemfiles/rails_6.0.gemfile
+- gemfiles/rails_6.1.gemfile
+- gemfiles/rails_7.0.gemfile
 - lib/generators/shortener/shortener_generator.rb
 - lib/generators/shortener/templates/migration.rb
 - lib/shortener.rb
@@ -215,7 +216,7 @@ files:
 homepage: http://jamespmcgrath.com/projects/shortener
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -230,8 +231,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 2.1.0
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubyforge_project:
+rubygems_version: 2.7.6
+signing_key:
 specification_version: 4
 summary: Shortener is a Rails Engine that makes it easy to create shortened URLs for
   your rails application.

data/.travis.yml

@@ -1,32 +0,0 @@
-language: ruby
-
-rvm:
-  - 2.2
-  - 2.3
-  - 2.4
-  - 2.5
-  - 2.6
-  - 2.7
-
-gemfile:
-  - gemfiles/rails_4.gemfile
-  - gemfiles/rails_5.0.gemfile
-  - gemfiles/rails_5.1.gemfile
-  - gemfiles/rails_5.2.gemfile
-  - gemfiles/rails_6.0.gemfile
-
-jobs:
-  fast_finish: true
-  exclude:
-  - rvm: 2.6
-    gemfile: gemfiles/rails_4.gemfile
-  - rvm: 2.7
-    gemfile: gemfiles/rails_4.gemfile
-  - rvm: 2.2
-    gemfile: gemfiles/rails_5.2.gemfile
-  - rvm: 2.2
-    gemfile: gemfiles/rails_6.0.gemfile
-  - rvm: 2.3
-    gemfile: gemfiles/rails_6.0.gemfile
-  - rvm: 2.4
-    gemfile: gemfiles/rails_6.0.gemfile

data/gemfiles/rails_5.0.gemfile

@@ -1,8 +0,0 @@
-# This file was generated by Appraisal
-
-source "http://rubygems.org"
-
-gem "rails", "~> 5.0.7"
-gem "sqlite3", "~> 1.3.6"
-
-gemspec path: "../"