acts_as_favoritor 2.0.1 → 2.1.0

data/lib/acts_as_favoritor/favoritor_lib.rb

@@ -1,57 +1,47 @@
-module ActsAsFavoritor
-    module FavoritorLib
-
-        private
+# frozen_string_literal: true
 
-        DEFAULT_PARENTS = [ApplicationRecord, ActiveRecord::Base]
+module ActsAsFavoritor
+  module FavoritorLib
+    private
 
-        # Retrieves the parent class name if using STI.
-        def parent_class_name obj
-            unless parent_classes.include? obj.class.superclass
-                return obj.class.base_class.name
-            end
-            obj.class.name
-        end
+    DEFAULT_PARENTS = [ApplicationRecord, ActiveRecord::Base].freeze
 
-        def apply_options_to_scope scope, options = {}
-            if options.has_key? :limit
-                scope = scope.limit options[:limit]
-            end
-            if options.has_key? :includes
-                scope = scope.includes options[:includes]
-            end
-            if options.has_key? :joins
-                scope = scope.joins options[:joins]
-            end
-            if options.has_key? :where
-                scope = scope.where options[:where]
-            end
-            if options.has_key? :order
-                scope = scope.order options[:order]
-            end
-            scope
-        end
+    # Retrieves the parent class name if using STI.
+    def parent_class_name(obj)
+      unless parent_classes.include? obj.class.superclass
+        return obj.class.base_class.name
+      end
+      obj.class.name
+    end
 
-        def parent_classes
-            return DEFAULT_PARENTS
-        end
+    def apply_options_to_scope(scope, options = {})
+      scope = scope.limit(options[:limit]) if options.key?(:limit)
+      scope = scope.includes(options[:includes]) if options.key?(:includes)
+      scope = scope.joins(options[:joins]) if options.key?(:joins)
+      scope = scope.where(options[:where]) if options.key?(:where)
+      scope = scope.order(options[:order]) if options.key?(:order)
+      scope
+    end
 
-        def validate_scopes method, options = {}
-            options[:scope] = options[:scope] || [ActsAsFavoritor.configuration.default_scope]
-            if options[:scope].size > 1
-                options[:multiple_scopes] = true
-            else
-                options[:multiple_scopes] = false
-                options[:scope] = options[:scope][0]
-            end
-            if options.has_key? :parameter
-                parameter = options[:parameter]
-                options.delete :parameter
-                send method, parameter, options
-            else
-                send method, options
-            end
-        end
+    def parent_classes
+      DEFAULT_PARENTS
+    end
 
+    def validate_scopes(method, options = {})
+      options[:scope] ||= [ActsAsFavoritor.configuration.default_scope]
+      if options[:scope].size > 1
+        options[:multiple_scopes] = true
+      else
+        options[:multiple_scopes] = false
+        options[:scope] = options[:scope][0]
+      end
+      if options.key? :parameter
+        parameter = options[:parameter]
+        options.delete :parameter
+        send(method, parameter, options)
+      else
+        send(method, options)
+      end
     end
+  end
 end

data/lib/acts_as_favoritor/railtie.rb

@@ -1,14 +1,14 @@
+# frozen_string_literal: true
+
 require 'rails/railtie'
 
 module ActsAsFavoritor
-    class Railtie < Rails::Railtie
-
-        initializer 'acts_as_favoritor.active_record' do
-            ActiveSupport.on_load :active_record do
-                include ActsAsFavoritor::Favoritor
-                include ActsAsFavoritor::Favoritable
-            end
-        end
-
+  class Railtie < Rails::Railtie
+    initializer 'acts_as_favoritor.active_record' do
+      ActiveSupport.on_load :active_record do
+        include ActsAsFavoritor::Favoritor
+        include ActsAsFavoritor::Favoritable
+      end
     end
+  end
 end

data/lib/acts_as_favoritor/version.rb

@@ -1,5 +1,5 @@
-module ActsAsFavoritor
-
-    VERSION = '2.0.1'
+# frozen_string_literal: true
 
+module ActsAsFavoritor
+  VERSION = '2.1.0'
 end

data/lib/generators/acts_as_favoritor_generator.rb

@@ -1,43 +1,43 @@
+# frozen_string_literal: true
+
 require 'rails/generators'
 require 'rails/generators/migration'
 
 class ActsAsFavoritorGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
 
-    include Rails::Generators::Migration
-
-    source_root File.join File.dirname(__FILE__), 'templates'
-    desc 'Install acts_as_favoritor'
-
-    def self.next_migration_number dirname
-        if ActiveRecord::Base.timestamped_migrations
-            Time.now.utc.strftime '%Y%m%d%H%M%S'
-        else
-            "%.3d" % (current_migration_number(dirname) + 1)
-        end
-    end
+  source_root(File.join(File.dirname(__FILE__), 'templates'))
+  desc 'Install acts_as_favoritor'
 
-    def create_initializer
-        template 'initializer.rb', 'config/initializers/acts_as_favoritor.rb'
+  def self.next_migration_number(dirname)
+    if ActiveRecord::Base.timestamped_migrations
+      Time.now.utc.strftime('%Y%m%d%H%M%S')
+    else
+      format('%.3d', current_migration_number(dirname) + 1)
     end
+  end
 
-    def create_migration_file
-        migration_template 'migration.rb.erb', 'db/migrate/acts_as_favoritor_migration.rb', migration_version: migration_version
-    end
+  def create_initializer
+    template 'initializer.rb', 'config/initializers/acts_as_favoritor.rb'
+  end
 
-    def create_model
-        template 'model.rb', 'app/models/favorite.rb'
-    end
+  def create_migration_file
+    migration_template(
+      'migration.rb.erb',
+      'db/migrate/acts_as_favoritor_migration.rb',
+      migration_version: migration_version
+    )
+  end
 
-    def show_readme
-        readme 'README.md'
-    end
+  def create_model
+    template 'model.rb', 'app/models/favorite.rb'
+  end
 
-    private
+  private
 
-    def migration_version
-        if Rails.version >= '5.0.0'
-            "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
-        end
-    end
+  def migration_version
+    return unless Rails.version >= '5.0.0'
 
+    "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
+  end
 end

data/lib/generators/templates/initializer.rb

@@ -1,9 +1,9 @@
-ActsAsFavoritor.configure do |config|
-
-    # Specify your default scope. Learn more about scopes here: https://github.com/jonhue/acts_as_favoritor#scopes
-    # config.default_scope = 'favorite'
-
-    # Enable caching. Learn more about caching here: https://github.com/jonhue/acts_as_favoritor#caching
-    # config.cache = false
-
-end
+# frozen_string_literal: true
+
+ActsAsFavoritor.configure do |config|
+  # Specify your default scope. Learn more about scopes here: https://github.com/jonhue/acts_as_favoritor#scopes
+  # config.default_scope = 'favorite'
+
+  # Enable caching. Learn more about caching here: https://github.com/jonhue/acts_as_favoritor#caching
+  # config.cache = false
+end

data/lib/generators/templates/migration.rb.erb

@@ -1,18 +1,20 @@
-class ActsAsFavoritorMigration < ActiveRecord::Migration<%= migration_version %>
-    def self.up
-        create_table :favorites, force: true do |t|
-            t.references :favoritable, polymorphic: true, null: false
-            t.references :favoritor, polymorphic: true, null: false
-            t.string :scope, default: ActsAsFavoritor.configuration.default_scope, null: false, index: true
-            t.boolean :blocked, default: false, null: false, index: true
-            t.timestamps
-        end
+# frozen_string_literal: true
 
-        add_index :favorites, ['favoritor_id', 'favoritor_type'], name: 'fk_favorites'
-        add_index :favorites, ['favoritable_id', 'favoritable_type'], name: 'fk_favoritables'
+class ActsAsFavoritorMigration < ActiveRecord::Migration<%= migration_version %>
+  def self.up
+    create_table :favorites, force: true do |t|
+      t.references :favoritable, polymorphic: true, null: false
+      t.references :favoritor, polymorphic: true, null: false
+      t.string :scope, default: ActsAsFavoritor.configuration.default_scope, null: false, index: true
+      t.boolean :blocked, default: false, null: false, index: true
+      t.timestamps
     end
 
-    def self.down
-        drop_table :favorites
-    end
+    add_index :favorites, ['favoritor_id', 'favoritor_type'], name: 'fk_favorites'
+    add_index :favorites, ['favoritable_id', 'favoritable_type'], name: 'fk_favoritables'
+  end
+
+  def self.down
+    drop_table :favorites
+  end
 end

data/lib/generators/templates/model.rb

@@ -1,13 +1,13 @@
-class Favorite < ActiveRecord::Base
-
-    extend ActsAsFavoritor::FavoritorLib
-    extend ActsAsFavoritor::FavoriteScopes
+# frozen_string_literal: true
 
-    belongs_to :favoritable, polymorphic: true
-    belongs_to :favoritor, polymorphic: true
+class Favorite < ActiveRecord::Base
+  extend ActsAsFavoritor::FavoritorLib
+  extend ActsAsFavoritor::FavoriteScopes
 
-    def block!
-        self.update_attributes blocked: true
-    end
+  belongs_to :favoritable, polymorphic: true
+  belongs_to :favoritor, polymorphic: true
 
+  def block!
+    update(blocked: true)
+  end
 end

metadata

@@ -1,125 +1,124 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_favoritor
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Jonas Hübotter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-01 00:00:00.000000000 Z
+date: 2018-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: factory_bot
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: shoulda_create
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: '5.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
-  name: shoulda
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: factory_girl
+  name: shoulda
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.8'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.8'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: shoulda_create
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: tzinfo-data
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.2017'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.2017'
+        version: '0'
 description: acts_as_favoritor is a Rubygem to allow any ActiveRecord model to associate
   any other model including the option for multiple relationships per association
   with scopes. You are able to differentiate followers, favorites, watchers, votes
   and whatever else you can imagine through a single relationship. This is accomplished
   by a double polymorphic relationship on the Favorite model. There is also built
   in support for blocking/un-blocking favorite records as well as caching.
-email: jonas.huebotter@gmail.com
+email: me@jonhue.me
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- CHANGELOG.md
 - LICENSE
 - README.md
 - lib/acts_as_favoritor.rb
@@ -131,7 +130,6 @@ files:
 - lib/acts_as_favoritor/railtie.rb
 - lib/acts_as_favoritor/version.rb
 - lib/generators/acts_as_favoritor_generator.rb
-- lib/generators/templates/README.md
 - lib/generators/templates/initializer.rb
 - lib/generators/templates/migration.rb.erb
 - lib/generators/templates/model.rb
@@ -139,10 +137,7 @@ homepage: https://github.com/jonhue/acts_as_favoritor
 licenses:
 - MIT
 metadata: {}
-post_install_message: |
-  **Thank you for installing acts_as_favoritor!**
-  Get started by running `rails g acts_as_favoritor`.
-  Learn more at https://github.com/jonhue/acts_as_favoritor.
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -158,7 +153,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.4
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: A Rubygem to add Favorite, Follow, Vote, etc. functionality to ActiveRecord