acts_as_footprintable 0.4.0 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 23d90af2f93fa15288f683b8376f4c4761918d5e
-  data.tar.gz: 5aab8f4d0f88e7e94031ff766b675d809a5db676
+SHA256:
+  metadata.gz: a4dda61f4d4e76bc6ee5251d8591b51f6888e7d70609cb16d21601faa07d2014
+  data.tar.gz: '0148bca9da729db5fe61d7c92da7c84ae5e0812ea15d49e73fdb328d37d4ba1e'
 SHA512:
-  metadata.gz: 0e4017dc629bd48cce469b8ed3d1d104e2300e76a53f9e64e4b1a74bde6cf1c4c2e99756ae52c5dfe6a692b4cb08c1f93d0635ff9a2b9ede5250deb731193720
-  data.tar.gz: '08b29b1c8e2b4424016c544eb27e41878f3b773f36316d9fefb7756cd6027f0ea5c3d8c7c750c805001f0e7aa52aeb3e2bdda6bce8db4f58c41ba1e78394e0db'
+  metadata.gz: a96376414507b2bb3067460c0f0a359afe11afe92ebb863dd2d69d8b7dd9cc82ada52c5e2a53f3f21b871780bc4edf71d1b57257c7af7bcc1232da8e99c13bde
+  data.tar.gz: a239b306ad678c186d65284c50099d2183eded818c78723ffdaa04f05819a110d7cba5f8e838d0aa100d9efe5d5c87563db753b95f400067b6572b4fb6e9d9b1

data/.github/workflows/gem-push.yml

@@ -0,0 +1,30 @@
+name: Ruby Gem
+
+on:
+  workflow_dispatch:
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby 2.6
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: 2.6.x
+
+      - name: Publish to RubyGems
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+          gem build *.gemspec
+          gem push *.gem
+        env:
+          GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/.github/workflows/test.yml

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

data/.gitignore

@@ -1,21 +1,19 @@
-*.iml
-.DS_Store
-.idea
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/log/
+
+# rspec failure tracking
+.rspec_status
+.ruby-version
 Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
-*.log
+.circleci/config.processed.yml
+
+/gemfiles/*.gemfile.lock
+/gemfiles/.bundle
+*.sqlite3

data/.rubocop.yml

@@ -0,0 +1,32 @@
+require:
+  - rubocop-performance
+  - rubocop-rake
+  - rubocop-minitest
+
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.6
+  Exclude:
+    - 'lib/generators/acts_as_footprintable/migration/templates/active_record/migration.rb'
+
+Layout/LineLength:
+  AllowHeredoc: true
+  AllowURI: true
+
+Metrics/MethodLength:
+  IgnoredMethods:
+    - acts_as_footprintable
+    - recent_footprint_ids
+
+Metrics/BlockLength:
+  IgnoredMethods:
+    - describe
+    - refine
+
+Layout/DotPosition:
+  EnforcedStyle: trailing
+
+Style/Documentation:
+  Enabled: false

data/Gemfile

@@ -1,20 +1,10 @@
-# coding: utf-8
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in acts_as_footprintable.gemspec
 gemspec
 
-rails_version = ENV['RAILS_VERSION'] || 'default'
-rails = case rails_version
-          when 'master'
-            { :github => 'rails/rails' }
-          when 'default'
-            '~> 3.2.0'
-          else
-            "~> #{rails_version}"
-        end
-
-gem 'rails', rails
-group :development do
-  gem 'combustion', '~> 0.5'
-end
+gem 'activerecord'
+gem 'sqlite3'

data/README.md

@@ -1,5 +1,6 @@
 # ActsAsFootprintable
-[![Build Status](https://travis-ci.org/patorash/acts_as_footprintable.png)](https://travis-ci.org/patorash/acts_as_footprintable)
+
+[![Test](https://github.com/patorash/acts_as_footprintable/actions/workflows/test.yml/badge.svg)](https://github.com/patorash/acts_as_footprintable/actions/workflows/test.yml)
 
 Acts As Footprintable is a Ruby Gem specifically written for Rails/ActiveRecord models.
 The main goals of this gem are:
@@ -11,12 +12,12 @@ The main goals of this gem are:
 
 ## Installation
 
-### Rails 3.2 and 4.0+
+### Rails 5.x, 6.x and 7.0
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'acts_as_footprintable', '~> 0.4.0'
+gem 'acts_as_footprintable', '~> 0.6.0'
 ```
 
 And then execute:
@@ -44,7 +45,7 @@ class Post < ActiveRecord::Base
   acts_as_footprintable
 end
 
-@post = Post.create(:name => 'my post!')
+@post = Post.create(name: 'my post!')
 
 @post.leave_footprints @user
 @post.footprints.size # => 1
@@ -91,10 +92,7 @@ post_access_histories = @user.access_histories_for(Post, 10)
 
 ## Testing
 
-All tests follow the RSpec format and located in the spec directory.
-They can be run with:
-
-    $ rake spec
+    $ bundle exec rake
 
 ## Contributing
 

data/Rakefile

@@ -1,10 +1,14 @@
-# coding: utf-8
-require "bundler/gem_tasks"
+# frozen_string_literal: true
 
-require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+require 'rake/testtask'
 
-desc "Run specs"
-RSpec::Core::RakeTask.new(:spec)
+task default: [:test]
 
-desc 'Default: run specs.'
-task :default => :spec
+Rake::TestTask.new do |test|
+  test.libs << 'lib'
+  test.libs << 'test'
+  test.test_files = Dir['test/**/*_test.rb']
+  test.warning = false
+  # test.verbose = true
+end

data/acts_as_footprintable.gemspec

@@ -1,29 +1,33 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+require 'English'
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'acts_as_footprintable/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "acts_as_footprintable"
+  spec.name          = 'acts_as_footprintable'
   spec.version       = ActsAsFootprintable::VERSION
-  spec.author        = "Toyoaki Oko"
-  spec.email         = "chariderpato@gmail.com"
-  spec.description   = %q{Rails gem to allowing records to leave footprints}
-  spec.summary       = %q{Rails gem to allowing records to leave footprints}
-  spec.homepage      = "https://github.com/patorash/acts_as_footprintable"
-  spec.license       = "MIT"
+  spec.author        = 'Toyoaki Oko'
+  spec.email         = 'chariderpato@gmail.com'
+  spec.description   = 'Rails gem to allowing records to leave footprints'
+  spec.summary       = 'Rails gem to allowing records to leave footprints'
+  spec.homepage      = 'https://github.com/patorash/acts_as_footprintable'
+  spec.license       = 'MIT'
+  spec.metadata['rubygems_mfa_required'] = 'true'
 
-  spec.files         = `git ls-files`.split($/)
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 2.6'
 
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec', ">= 3.0.0"
-  spec.add_development_dependency 'pg'
-  spec.add_development_dependency 'timecop'
-  spec.add_development_dependency 'database_cleaner', "~> 1.0.1"
-  spec.add_development_dependency 'pry'
-  #spec.add_development_dependency 'combustion', '~> 0.5.1'
+  spec.add_dependency 'activerecord', '< 7.1.0', '>= 5.0.0'
+  spec.add_development_dependency 'database_cleaner', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rubocop', '~> 1.24'
+  spec.add_development_dependency 'rubocop-minitest', '~> 0.17'
+  spec.add_development_dependency 'rubocop-performance', '~> 1.13'
+  spec.add_development_dependency 'rubocop-rake', '~> 0.6'
+  spec.add_development_dependency 'sqlite3', '~> 1.3'
 end

data/config.ru

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'rubygems'
+require 'bundler'
+
+Bundler.require :default, :development
+
+Combustion.initialize! :all
+run Combustion::Application

data/gemfiles/rails_5.0.gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gem 'activerecord', '~> 5.0.0'
+gem 'sqlite3', '~> 1.3.0'
+
+gemspec path: '../'

data/gemfiles/rails_5.1.gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gem 'activerecord', '~> 5.1.0'
+gem 'sqlite3', '~> 1.3.0'
+
+gemspec path: '../'

data/gemfiles/rails_5.2.gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gem 'activerecord', '~> 5.2.0'
+gem 'sqlite3', '~> 1.4'
+
+gemspec path: '../'

data/gemfiles/rails_6.0.gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gem 'activerecord', '~> 6.0.0'
+gem 'sqlite3', '~> 1.4'
+
+gemspec path: '../'

data/gemfiles/rails_6.1.gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gem 'activerecord', '~> 6.1.0'
+gem 'sqlite3', '~> 1.4'
+
+gemspec path: '../'

data/gemfiles/rails_7.0.gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gem 'activerecord', '~> 7.0.1'
+gem 'sqlite3', '~> 1.4'
+
+gemspec path: '../'

data/lib/acts_as_footprintable/extenders/footprintable.rb

@@ -1,4 +1,5 @@
-# coding: utf-8
+# frozen_string_literal: true
+
 module ActsAsFootprintable
   module Extenders
     module Footprintable
@@ -15,9 +16,9 @@ module ActsAsFootprintable
             true
           end
 
-          def self.access_ranking(range=nil, limit=nil)
+          def self.access_ranking(range = nil, limit = nil)
             records = Footprint.for_type(self)
-            records = records.where(:created_at => range) unless range.nil?
+            records = records.where(created_at: range) unless range.nil?
             records = records.limit(limit) unless limit.nil?
             records.group(:footprintable_id).order('count_footprintable_id desc').count(:footprintable_id)
           end
@@ -25,4 +26,4 @@ module ActsAsFootprintable
       end
     end
   end
-end
+end

data/lib/acts_as_footprintable/extenders/footprinter.rb

@@ -1,4 +1,5 @@
-# coding: utf-8
+# frozen_string_literal: true
+
 module ActsAsFootprintable
   module Extenders
     module Footprinter
@@ -6,7 +7,7 @@ module ActsAsFootprintable
         false
       end
 
-      def acts_as_footprinter(*args)
+      def acts_as_footprinter(*_args)
         require 'acts_as_footprintable/footprinter'
         include ActsAsFootprintable::Footprinter
 
@@ -18,4 +19,4 @@ module ActsAsFootprintable
       end
     end
   end
-end
+end

data/lib/acts_as_footprintable/footprint.rb

@@ -1,19 +1,14 @@
-# coding: utf-8
+# frozen_string_literal: true
+
 module ActsAsFootprintable
   class Footprint < ::ActiveRecord::Base
-    if ::ActiveRecord::VERSION::MAJOR < 4
-      attr_accessible :footprintable_id, :footprintable_type,
-                      :footprinter_id,  :footprinter_type,
-                      :footprintable, :footprinter
-    end
-
-    belongs_to :footprintable, :polymorphic => true
-    belongs_to :footprinter, :polymorphic => true
+    belongs_to :footprintable, polymorphic: true
+    belongs_to :footprinter, polymorphic: true
 
-    scope :for_type, lambda{|klass| where(:footprintable_type => klass.name)}
-    scope :by_type,  lambda{|klass| where(:footprinter_type   => klass.name)}
+    scope :for_type, ->(klass) { where(footprintable_type: klass.name) }
+    scope :by_type,  ->(klass) { where(footprinter_type: klass.name) }
 
-    validates :footprintable_id, :presence => true
-    validates :footprinter_id, :presence => true
+    validates :footprintable_id, presence: true
+    validates :footprinter_id, presence: true
   end
-end
+end

data/lib/acts_as_footprintable/footprintable.rb

@@ -1,10 +1,10 @@
-# coding: utf-8
+# frozen_string_literal: true
+
 module ActsAsFootprintable
   module Footprintable
-
     def self.included(base)
       base.class_eval do
-        has_many :footprints, :class_name => 'ActsAsFootprintable::Footprint', :as => :footprintable, :dependent => :destroy do
+        has_many :footprints, class_name: 'ActsAsFootprintable::Footprint', as: :footprintable, dependent: :destroy do
           def footprinters
             includes(:footprinter).map(&:footprinter)
           end
@@ -13,12 +13,8 @@ module ActsAsFootprintable
     end
 
     def leave_footprints(footprinter)
-      footprint = ActsAsFootprintable::Footprint.new(:footprintable => self, :footprinter => footprinter)
-      if footprint.save
-        true
-      else
-        false
-      end
+      footprint = ActsAsFootprintable::Footprint.new(footprintable: self, footprinter: footprinter)
+      footprint.save
     end
 
     def footprint_count
@@ -26,7 +22,7 @@ module ActsAsFootprintable
     end
 
     def footprint_count_between(range)
-      footprints.where(:created_at => range).count
+      footprints.where(created_at: range).count
     end
   end
 end

data/lib/acts_as_footprintable/footprinter.rb

@@ -1,9 +1,10 @@
-# coding: utf-8
+# frozen_string_literal: true
+
 module ActsAsFootprintable
   module Footprinter
     def self.included(base)
       base.class_eval do
-        has_many :footprints, :class_name => 'ActsAsFootprintable::Footprint', :as => :footprinter, :dependent => :destroy do
+        has_many :footprints, class_name: 'ActsAsFootprintable::Footprint', as: :footprinter, dependent: :destroy do
           def footprintable
             includes(:footprintable).map(&:footprintable)
           end
@@ -12,38 +13,50 @@ module ActsAsFootprintable
     end
 
     def leave_footprints(footprintable)
-      footprint = ActsAsFootprintable::Footprint.new(:footprintable => footprintable, :footprinter => self)
-      if footprint.save
-        true
-      else
-        false
-      end
+      footprint = ActsAsFootprintable::Footprint.new(footprintable: footprintable, footprinter: self)
+      footprint.save
     end
 
-    def access_histories_for(klass, limit=nil)
+    def access_histories_for(klass, limit = nil)
       get_access_history_records(footprints.for_type(klass), limit)
     end
 
-    def access_histories(limit=nil)
+    def access_histories(limit = nil)
       get_access_history_records(footprints, limit)
     end
 
     private
-    def get_access_history_records(target, limit=nil)
-      footprints.where(:id => recent_footprint_ids(target, limit)).order("created_at DESC")
+
+    def get_access_history_records(target, limit = nil)
+      footprints.where(id: recent_footprint_ids(target, limit)).order('created_at DESC')
     end
 
     def table_name
       ActsAsFootprintable::Footprint.table_name
     end
 
-    def recent_footprint_ids(target, limit=nil)
-      recent_footprints = target.group("#{table_name}.footprintable_id, #{table_name}.footprintable_type").
-          select("#{table_name}.footprintable_id, #{table_name}.footprintable_type, MAX(#{table_name}.created_at) AS created_at")
-      records = footprints.where("(#{table_name}.footprintable_id, #{table_name}.footprintable_type, #{table_name}.created_at) IN (#{recent_footprints.to_sql})")
-      records = records.order("footprints.created_at desc")
+    def recent_footprint_ids(target, limit = nil)
+      records = footprints.where(<<~SQL)
+        (
+          #{table_name}.footprintable_id,
+          #{table_name}.footprintable_type,
+          #{table_name}.created_at
+        ) IN (#{recent_footprints_by(target).to_sql})
+      SQL
+      records = records.order('footprints.created_at desc')
       records = records.limit(limit) unless limit.nil?
-      records.pluck(:id)
+      records.ids
+    end
+
+    def recent_footprints_by(target)
+      target.group(
+        "#{table_name}.footprintable_id",
+        "#{table_name}.footprintable_type"
+      ).select(
+        "#{table_name}.footprintable_id",
+        "#{table_name}.footprintable_type",
+        "MAX(#{table_name}.created_at) AS created_at"
+      )
     end
   end
-end
+end

data/lib/acts_as_footprintable/version.rb

@@ -1,4 +1,5 @@
-# coding: utf-8
+# frozen_string_literal: true
+
 module ActsAsFootprintable
-  VERSION = "0.4.0"
+  VERSION = '0.6.2'
 end

data/lib/acts_as_footprintable.rb

@@ -1,4 +1,5 @@
-# coding: utf-8
+# frozen_string_literal: true
+
 require 'active_record'
 require 'active_support/inflector'
 

data/lib/generators/acts_as_footprintable/migration/migration_generator.rb

@@ -1,32 +1,43 @@
-# coding: utf-8
+# frozen_string_literal: true
+
 require 'rails/generators/migration'
 
 module ActsAsFootprintable
   class MigrationGenerator < Rails::Generators::Base
     include Rails::Generators::Migration
 
-    desc "Generators migration for footprintable(footprints table)"
+    desc 'Generators migration for footprintable(footprints table)'
 
     def self.orm
       Rails::Generators.options[:rails][:orm]
     end
 
     def self.source_root
-      File.join(File.dirname(__FILE__), 'templates', (orm.to_s unless orm.class.eql?(String)))
+      File.join(File.dirname(__FILE__), 'templates', (orm.to_s unless orm.instance_of?(String)))
     end
 
     def self.orm_has_migration?
       [:active_record].include? orm
     end
 
-    def self.next_migration_number(path)
-      Time.now.utc.strftime("%Y%m%d%H%M%S")
+    def self.next_migration_number(_path)
+      Time.now.utc.strftime('%Y%m%d%H%M%S')
     end
 
     def create_migration_file
-      if self.class.orm_has_migration?
-        migration_template 'migration.rb', 'db/migrate/acts_as_footprintable_migration'
-      end
+      return unless self.class.orm_has_migration?
+
+      migration_template 'migration.rb',
+                         'db/migrate/acts_as_footprintable_migration.rb',
+                         migration_version: migration_version
+    end
+
+    def migration_version
+      "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]" if over_rails5?
+    end
+
+    def over_rails5?
+      Rails::VERSION::MAJOR >= 5
     end
   end
-end
+end

data/lib/generators/acts_as_footprintable/migration/templates/active_record/migration.rb

@@ -1,10 +1,11 @@
-# coding: utf-8
-class ActsAsFootprintableMigration < ActiveRecord::Migration
+# frozen_string_literal: true
+
+class ActsAsFootprintableMigration < ActiveRecord::Migration<%= migration_version %>
   def self.up
     create_table :footprints do |t|
-      t.references :footprintable, :polymorphic => true
-      t.references :footprinter, :polymorphic => true
-      t.timestamps :null => false
+      t.references :footprintable, polymorphic: true
+      t.references :footprinter, polymorphic: true
+      t.timestamps null: false
     end
 
     if ActiveRecord::VERSION::MAJOR < 4