acts_as_favoritor 1.1.0 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0212cb5d6caa611de18d2d40fdc63d222cb53fbd
-  data.tar.gz: 80a038d9ede85643ee8ef0f603e80ba6c5f4c621
+  metadata.gz: 76ca5a001f34e1c116394acdf0b14ee10e7af8eb
+  data.tar.gz: b3fb2d0f0eea52611bb492f7c2c547971dbf24b5
 SHA512:
-  metadata.gz: 6bd55853cbcfad24a096d22148f0ad9f8db4da64a8a9c8af89af0436c9debd0de3a24cfe6420fd07a96f9fd85f690c6d37b6dedc3762ad214712477e6f485bfc
-  data.tar.gz: d34d88eac6378f1a700409ee854a6e2f9c7257a700984cc63ee708fccf753eecdb57bb4a8812afbdacaabaa3b802fc8d3c5fd8f476a72f10a44e2c94fccc548a
+  metadata.gz: ee98332d5dcbad109d348d4a6ef86fecc6709b8f5d5a497da404adecdc78404f91a389c9e4a60592fb8c542210503ed43471362a39601794ffd8475527f67256
+  data.tar.gz: 262e4a3890b63782f77b302b3a792bf4bc311199b6fabaacdde5f826fb21a283cb620cb3e840fa17192f8e2f240eb86c02f2c7ab9f845a7e4dc615d73d39072b

data/CHANGELOG.md

@@ -0,0 +1,39 @@
+# Changelog
+
+### unreleased
+
+* nothing yet
+
+### 1.1.2 - 2017-08-23
+
+* bugfixes
+    * migration hotfix
+
+### 1.1.1 - 2017-08-23
+
+* notes
+    * default scope changed from `favorites` to `favorite`
+* features
+    * added configuration
+* enhancements
+    * add `scope` generator option
+    * add `skip_configuration` generator option
+    * index database columns
+* minor bugfixes
+
+### 1.1.0 - 2017-08-23
+
+* features
+    * add scope functionality
+
+### 1.0.2 - 2017-08-22
+
+* enhancements
+
+### 1.0.1 - 2017-08-22
+
+* bug fixes
+
+### 1.0.0 - 2017-08-22
+
+* initial release

data/README.md

@@ -17,6 +17,7 @@ You are able to differentiate followers, favorites, watchers and whatever else y
     * [`acts_as_favoritable` methods](#acts_as_favoritable-methods)
     * [`Favorite` model](#favorite-model)
     * [Scopes](#scopes)
+* [Configuration](#configuration)
 * [Testing](#testing)
     * [Test Coverage](#test-coverage)
 * [Contributing](#contributing)
@@ -51,12 +52,17 @@ Now run the generator:
 
     $ rails g acts_as_favoritor
 
-    $ rails db:migrate
+You can set your default scope by passing `--scope custom_scope`. Learn more about scopes [here](#scopes)
+You can skip the creation of a configuration file by passing `--skip_configuration`. Learn more about configuring `acts_as_favoritor` [here](#configuration)
 
-This will create a Favorite model as well as a migration file.
+To wrap things up, migrate the changes into your database:
+
+    $ rails db:migrate
 
 **Note:** Use `rake db:migrate` instead if you run Rails < 5.
 
+This will create a Favorite model as well as a migration file.
+
 ## Usage
 
 ### Setup
@@ -198,16 +204,16 @@ Favorite.for_favoritable book
 
 ### Scopes
 
-Using scopes with `acts_as_favoritor` enables you to Follow, Watch, Favorite, [...] between any of your models. This way you can separate distinct functionalities in your app between user states. For example: A user sees all his favorited books in a dashboard (`'favorites'`), but he only receives notifications for those, he is watching (`'watching'`). Just like YouTube does it.
+Using scopes with `acts_as_favoritor` enables you to Follow, Watch, Favorite, [...] between any of your models. This way you can separate distinct functionalities in your app between user states. For example: A user sees all his favorited books in a dashboard (`'favorite'`), but he only receives notifications for those, he is watching (`'watch'`). Just like YouTube does it.
 
-By default all of your favorites are scoped to `'favorites'`.
+By default all of your favorites are scoped to `'favorite'`.
 
 You can create new scopes on the fly. Every single method takes `scope` as an option which expexts an array containing your scopes as strings.
 
 So lets see how this works:
 
 ```ruby
-user.favorite book, scope: [:favorites, :watching]
+user.favorite book, scope: [:favorite, :watching]
 user.remove_favorite book, scope: [:watching]
 book.block user, scope: [:all] # applies to all scopes
 ```
@@ -217,7 +223,7 @@ That's simple!
 When you call a method which returns something while specifying multiple scopes, the method returns the results in a hash with the scopes as keys:
 
 ```ruby
-user.favorited? book, scope: [:favorites, :watching] # => { favorites: true, watching: false }
+user.favorited? book, scope: [:favorite, :watching] # => { favorite: true, watching: false }
 user.favorited? book, scope: [:all] # => true
 ```
 
@@ -229,7 +235,7 @@ Favorite.send(my_scope + '_list')
 
 ## Examples
 ### Returns all `Favorite` records where `scope` is `favorites`
-Favorite.favorites_list
+Favorite.favorite_list
 ### Returns all `Favorite` records where `scope` is `watching`
 Favorite.watching_list
 ### Very unnecessary, but `all_list` returns literally all `Favorite` records
@@ -238,6 +244,20 @@ Favorite.all_list
 
 ---
 
+## Configuration
+
+The installer creates a yaml config file for you (`config/acts_as_favoritor.yml`). Inside of that file you are able to adopt this gem to your specific needs.
+
+When you delete this file, all settings will rollback to their defaults. You can prevent the creation of this configuration file when running the generator by passing the option `--skip_configuration`.
+
+Currently supported Settings:
+
+**default_scope:** Specify your default scope. Learn more about scopes here: https://github.com/slooob/acts_as_favoritor#scopes
+
+If you have an idea for a new setting, propose it by creating a new [issue](https://github.com/slooob/acts_as_favoritor/issues).
+
+---
+
 ## Testing
 
 Tests are written with Shoulda on top of `Test::Unit` with Factory Girl being used instead of fixtures. Tests are run using rake.

data/acts_as_favoritor.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |gem|
     gem.authors     = ['Jonas Hübotter']
     gem.email       = ['developer@slooob.com']
     gem.homepage    = 'https://github.com/slooob/acts_as_favoritor'
-    gem.summary     = 'A Rubygem to add Favorite functionality for ActiveRecord models'
+    gem.summary     = 'A Rubygem to add Favorite, Follow, etc. functionality to ActiveRecord models'
     gem.description = 'acts_as_favoritor is a Rubygem to allow any ActiveRecord model to favorite any other model. This is accomplished through a double polymorphic relationship on the Favorite model. There is also built in support for blocking/un-blocking favorite records.'
     gem.license     = 'MIT'
 

data/lib/acts_as_favoritor.rb

@@ -9,4 +9,6 @@ module ActsAsFavoritor
 
     require 'acts_as_favoritor/railtie' if defined?(Rails)
 
+    require 'acts_as_favoritor/configuration'
+
 end

data/lib/acts_as_favoritor/configuration.rb

@@ -0,0 +1,25 @@
+module ActsAsFavoritor
+
+    def self.default_scope
+        config = get_config
+        if config&.key :default_scope
+            config[:default_scope]
+        else
+            'favorite'
+        end
+    end
+
+
+    private
+
+
+    def self.get_config
+        require 'yaml'
+
+        begin
+            YAML.load_file 'config/acts_as_favoritor.yml'
+        rescue Exception
+        end
+    end
+
+end

data/lib/acts_as_favoritor/favorite_scopes.rb

@@ -1,15 +1,20 @@
 module ActsAsFavoritor #:nodoc:
     module FavoriteScopes
 
-        # send(scope + '_list') - returns favorite records of scope
-        Favorite.all.group_by(&:scope).each do |s|
-            Favorite.send(:define_method, "#{s}_list") do
-                where scope: s
+        # Allows magic names on send(scope + '_list') - returns favorite records of certain scope
+        # e.g. favoritors == favoritors.send('favorite_list')
+        def method_missing m, *args
+            if m.to_s[/(.+)_list/]
+                where scope: $1.singularize.classify
+            else
+                super
             end
         end
-        def favorites_list
-            where scope: 'favorites'
+
+        def respond_to? m, include_private = false
+            super || m.to_s[/(.+)_list/]
         end
+
         def all_list
             all
         end

data/lib/acts_as_favoritor/favoritor_lib.rb

@@ -37,7 +37,7 @@ module ActsAsFavoritor
         end
 
         def validate_scopes method, options = {}
-            options[:scope] = options[:scope] || ['favorites']
+            options[:scope] = options[:scope] || ActsAsFavoritor.default_scope
             if options[:scope].size > 1
                 options[:multiple_scopes] = true
             else

data/lib/acts_as_favoritor/version.rb

@@ -1,5 +1,5 @@
 module ActsAsFavoritor
 
-    VERSION = '1.1.0'
+    VERSION = '1.1.2'
 
 end

data/lib/generators/acts_as_favoritor_generator.rb

@@ -5,9 +5,10 @@ class ActsAsFavoritorGenerator < Rails::Generators::Base
 
     include Rails::Generators::Migration
 
-    def self.source_root
-        @source_root ||= File.join File.dirname(__FILE__), 'templates'
-    end
+    source_root File.join File.dirname(__FILE__), 'templates'
+    desc 'Install acts_as_favoritor'
+    class_option :scope, desc: 'Specify your default scope. Learn more about scopes here: https://github.com/slooob/acts_as_favoritor#scopes', type: :string, default: 'favorite', aliases: '-s'
+    class_option :skip_configuration, desc: 'Skip the creation of the configuration file. Learn more about configuring acts_as_favoritor here: https://github.com/slooob/acts_as_favoritor#configuration', type: :boolean, default: false
 
     def self.next_migration_number dirname
         if ActiveRecord::Base.timestamped_migrations
@@ -25,6 +26,10 @@ class ActsAsFavoritorGenerator < Rails::Generators::Base
         template 'model.rb', 'app/models/favorite.rb'
     end
 
+    def create_configuration
+        template 'acts_as_favoritor.yml.erb', 'config/acts_as_favoritor.yml' unless options[:skip_configuration]
+    end
+
     def show_readme
         readme 'README.md'
     end

data/lib/generators/templates/acts_as_favoritor.yml.erb

@@ -0,0 +1,6 @@
+# ----------
+# ACTS AS FAVORITOR
+# ----------
+
+# Specify your default scope. Learn more about scopes here: https://github.com/slooob/acts_as_favoritor#scopes
+default_scope: <%= options[:scope] %>

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

@@ -3,8 +3,8 @@ class ActsAsFavoritorMigration < ActiveRecord::Migration<% if Rails::VERSION::MA
         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: 'favorites', null: false
-            t.boolean :blocked, default: false, null: false
+            t.string :scope, default: ActsAsFavoritor.default_scope, null: false, index: true
+            t.boolean :blocked, default: false, null: false, index: true
             t.timestamps
         end
 

data/test/schema.rb

@@ -5,7 +5,7 @@ ActiveRecord::Schema.define version: 0 do
         t.string   'favoritable_type', null: false
         t.integer  'favoritor_id', null: false
         t.string   'favoritor_type', null: false
-        t.string :scope, default: 'favorites', null: false
+        t.string :scope, default: ActsAsFavoritor.default_scope, null: false
         t.boolean  'blocked', default: false, null: false
         t.datetime 'created_at'
         t.datetime 'updated_at'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_favoritor
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.2
 platform: ruby
 authors:
 - Jonas Hübotter
@@ -122,6 +122,7 @@ files:
 - ".github/pull_request_template.md"
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
 - DEPRECATIONS.md
@@ -132,6 +133,7 @@ files:
 - acts_as_favoritor.gemspec
 - init.rb
 - lib/acts_as_favoritor.rb
+- lib/acts_as_favoritor/configuration.rb
 - lib/acts_as_favoritor/favoritable.rb
 - lib/acts_as_favoritor/favorite_scopes.rb
 - lib/acts_as_favoritor/favoritor.rb
@@ -140,6 +142,7 @@ files:
 - lib/acts_as_favoritor/version.rb
 - lib/generators/acts_as_favoritor_generator.rb
 - lib/generators/templates/README.md
+- lib/generators/templates/acts_as_favoritor.yml.erb
 - lib/generators/templates/migration.rb.erb
 - lib/generators/templates/model.rb
 - test/acts_as_favoritable_test.rb
@@ -193,5 +196,5 @@ rubyforge_project:
 rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
-summary: A Rubygem to add Favorite functionality for ActiveRecord models
+summary: A Rubygem to add Favorite, Follow, etc. functionality to ActiveRecord models
 test_files: []