action-store 0.3.2 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6eba4261de49d8c71efd8375217b93c80d57ab45
-  data.tar.gz: 20d7a28f9b8005110f4cd564d2a771b541b1beea
+SHA256:
+  metadata.gz: d3f20d025cda1c0724c4b9b053288efb85d714069d90fff728c59affc3a47da0
+  data.tar.gz: c94553d106707178ffd85c2c2e2aef41feaaa040441faf4fca96356ec46a5fc2
 SHA512:
-  metadata.gz: ed468a935c04a2714b19a63e9506c31faef01acd946e54ef22aeea3e9cec8973467293cc494f7f23470a9e6ea1d92b550e4d5c7b9f1c2676ad5241a3e81af368
-  data.tar.gz: 9a4333d0d4e503aa20b643d4de570b494143581f564ee443fe6106f178f8889702eb19b5819e3591dfe6a9a7aca9f0f433f335e5bd24ea3b73140f8d1448e6cb
+  metadata.gz: cb20154fbc1dba325e3a40415d7940b37f7e52aa1dfc877da24ba6cdb5691f0f99788b7a737688f083ff37ee8659393496344febaf0d62b97e08db5f61b378fb
+  data.tar.gz: 3f925347dca40f57691af345af33e47fbd58d0b6b24deaabe0d89f3ebad3d24874d050783387d3dfc216fe500d3f31cf5d7682e99b5ac5935fc7760296ed7765

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+0.3.3
+-----
+
+- Fix for supports Rails 5.2;
+
 0.3.2
 -----
 

data/README.md

@@ -3,13 +3,13 @@ ActionStore
 
 [![Gem Version](https://badge.fury.io/rb/action-store.svg)](https://badge.fury.io/rb/action-store) [![Build Status](https://travis-ci.org/rails-engine/action-store.svg)](https://travis-ci.org/rails-engine/action-store) [![Code Climate](https://codeclimate.com/github/rails-engine/action-store/badges/gpa.svg)](https://codeclimate.com/github/rails-engine/action-store) [![codecov.io](https://codecov.io/github/rails-engine/action-store/coverage.svg?branch=master)](https://codecov.io/github/rails-engine/action-store?branch=master)
 
-Store different kind of actions (Like, Follow, Star, Block ...) in one table via ActiveRecord Polymorphic Association.
+Store different kinds of actions (Like, Follow, Star, Block, etc.) in a single table via ActiveRecord Polymorphic Associations.
 
-- Like Post/Comment/Reply ...
-- Watch/Subscribe Post
-- Follow User
-- Favorite Post
-- Read Notification/Message
+- Like Posts/Comment/Reply ...
+- Watch/Subscribe to Posts
+- Follow Users
+- Favorite Posts
+- Read Notifications/Messages
 
 And more and more.
 
@@ -17,11 +17,11 @@ And more and more.
 
 ## Basic table struct
 
-| Field | Means |
+| Column | Description |
 | ----- | ----- |
 | `action_type` | The type of action [like, watch, follow, star, favorite] |
-| `action_option` | Secondly option for store you custom status, or you can let it null if you don't needs it. |
-| `target_type`, `target_id` | Polymorphic Association for difference `Target` models [User, Post, Comment] |
+| `action_option` | Secondary option for storing your custom status, or null if unneeded. |
+| `target_type`, `target_id` | Polymorphic Association for different `Target` models [User, Post, Comment] |
 
 ## Usage
 
@@ -43,7 +43,7 @@ and run `rails db:migrate`.
 
 ### Define Actions
 
-You can use `action_store` to define actions:
+Use `action_store` to define actions:
 
 app/models/user.rb
 
@@ -78,7 +78,7 @@ end
 
 ### Counter Cache
 
-And you need add counter_cache field to target, user table.
+Add counter_cache field to target and user tables.
 
 ```rb
 add_column :users, :star_posts_count, :integer, default: 0
@@ -91,9 +91,9 @@ add_column :posts, :stars_count, :integer, default: 0
 add_column :comments, :likes_count, :integer, default: 0
 ```
 
-#### Now you can use like this:
+#### Example usage:
 
-@user -> like @post
+@user likes @post
 
 ```rb
 irb> User.create_action(:like, target: @post, user: @user)
@@ -104,7 +104,7 @@ irb> @post.reload.likes_count
 1
 ```
 
-@user1 -> unlike @user2
+@user1 unlikes @user2
 
 ```rb
 irb> User.destroy_action(:follow, target: @post, user: @user)
@@ -115,7 +115,7 @@ irb> @post.reload.likes_count
 0
 ```
 
-Check @user1 is liked @post
+Check if @user1 likes @post
 
 ```rb
 irb> action = User.find_action(:follow, target: @post, user: @user)
@@ -124,7 +124,7 @@ irb> action.present?
 true
 ```
 
-User follow cases:
+Other following use cases:
 
 ```rb
 # @user1 -> follow @user2
@@ -141,11 +141,11 @@ User follow cases:
  @user1.destroy_action(:follow, target: @user3)
 ```
 
-## Builtin relations and methods
+## Built-in relations and methods
 
-When you called `action_store`, ActionStore will define Many-to-Many relations for User and Target model.
+When you call `action_store`, ActionStore will define many-to-many relations for User and Target models.
 
-for example:
+For example:
 
 ```rb
 class User < ActiveRecord::Base
@@ -154,10 +154,10 @@ class User < ActiveRecord::Base
 end
 ```
 
-It will defines Many-to-Many relations:
+Defines many-to-many relations:
 
-- For User model will defined: `<action>_<target>s` (like_posts)
-- For Target model will defined: `<action>_by_users` (like_by_users)
+- For User model: `<action>_<target>s` (like_posts)
+- For Target model: `<action>_by_users` (like_by_users)
 
 ```rb
 # for User model
@@ -175,7 +175,7 @@ has_many :like_by_user_actions
 has_many :like_by_users, through: :like_user_actions
 ```
 
-And `User` model will have methods:
+And `User` model will now have methods:
 
 - @user.create_action(:like, target: @post)
 - @user.destroy_action(:like, target: @post)

data/Rakefile

@@ -1,30 +1,31 @@
+# frozen_string_literal: true
 begin
-  require 'bundler/setup'
+  require "bundler/setup"
 rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
 end
 
-require 'rdoc/task'
+require "rdoc/task"
 
 RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'Actionstore'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.md')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title    = "Actionstore"
+  rdoc.options << "--line-numbers"
+  rdoc.rdoc_files.include("README.md")
+  rdoc.rdoc_files.include("lib/**/*.rb")
 end
 
 APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
-load 'rails/tasks/engine.rake'
-load 'rails/tasks/statistics.rake'
+load "rails/tasks/engine.rake"
+load "rails/tasks/statistics.rake"
 
-require 'bundler/gem_tasks'
-require 'rake/testtask'
+require "bundler/gem_tasks"
+require "rake/testtask"
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib'
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
+  t.libs << "lib"
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
   t.verbose = false
 end
 

data/app/models/action.rb

@@ -1,4 +1,5 @@
+# frozen_string_literal: true
 # Auto generate with action-store gem.
 class Action < ActiveRecord::Base
   include ActionStore::Model
-end
+end

data/config/initializers/action_store.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # ActionStore Config
 ActionStore.configure do
-end
+end

data/db/migrate/20170204035500_create_actions.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class CreateActions < ActiveRecord::Migration[5.0]
   def change
     create_table :actions do |t|

data/lib/action-store.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "action_store/version"
 require "action_store/configuration"
 require "action_store/engine"

data/lib/action_store/configuration.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ActionStore
   class Configuration
   end

data/lib/action_store/engine.rb

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
 module ActionStore
   class Engine < ::Rails::Engine
     isolate_namespace ActionStore
 
     initializer "action_store.init_action", after: :load_config_initializers do
       # Ensure eager_load Action model to init methods
-      require 'action'
+      require "action"
     end
   end
-end
+end

data/lib/action_store/mixin.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ActionStore
   module Mixin
     extend ActiveSupport::Concern
@@ -33,7 +34,6 @@ module ActionStore
 
       def action_store(action_type, name, opts = {})
         opts ||= {}
-        target_type = name
         klass_name = opts[:class_name] || name.to_s.classify
         target_klass = klass_name.constantize
         action_type = action_type.to_s
@@ -110,7 +110,8 @@ module ActionStore
         if defined_action[:counter_cache] && action.target.present?
           target_count = Action.where(
             action_type: defined_action[:action_type],
-            target: action.target
+            target_type: action.target_type,
+            target_id: action.target_id
           ).count
           action.target.update_attribute(defined_action[:counter_cache], target_count)
         end
@@ -118,7 +119,8 @@ module ActionStore
           user_count = Action.where(
             action_type: defined_action[:action_type],
             target_type: action.target_type,
-            user: action.user
+            user_type: action.user_type,
+            user_id: action.user_id
           ).count
           action.user.update_attribute(defined_action[:user_counter_cache], user_count)
         end
@@ -126,103 +128,103 @@ module ActionStore
 
       private
 
-      def define_relations(action)
-        target_klass = action[:target_klass]
-        action_type = action[:action_type]
-        action_name = action[:action_name]
-
-        user_klass = self
-
-        # user, person
-        user_name = user_klass.table_name.underscore.singularize
-
-        # like_topic, follow_user
-        full_action_name = [action_type, action_name].join('_')
-        # like_user, follow_user
-        full_action_name_for_target = [action_type, 'by', user_name].join('_')
-        # unlike_topic, unfollow_user
-        unaction_name = "un#{full_action_name}"
-
-        # @target.like_topic_actions, @target.follow_user_actions
-        has_many_name = [full_action_name, 'actions'].join('_').to_sym
-        # @target.like_topics, @target.follow_users
-        has_many_through_name = full_action_name.pluralize.to_sym
-
-        # @user.like_by_user_actions, @user.follow_by_user_actions
-        has_many_name_for_target = [full_action_name_for_target, 'actions'].join('_').to_sym
-        # @user.like_by_users, @user.follow_by_users
-        has_many_through_name_for_target = full_action_name_for_target.pluralize.to_sym
-
-        has_many_scope = -> {
-          where(action_type: action_type, target_type: target_klass.name, user_type: user_klass.name)
-        }
-
-        # User has_many :like_topic_actions
-        user_klass.send :has_many, has_many_name, has_many_scope,
-          class_name: 'Action',
-          foreign_key: 'user_id'
-        # User has_many :like_topics
-        user_klass.send :has_many, has_many_through_name,
-          through: has_many_name,
-          source: :target,
-          source_type: target_klass.name
-
-        # Topic has_many :like_user_actions
-        target_klass.send :has_many, has_many_name_for_target, has_many_scope,
-          foreign_key: :target_id,
-          class_name: 'Action'
-        # Topic has_many :like_users
-        target_klass.send :has_many, has_many_through_name_for_target,
-          through: has_many_name_for_target,
-          source_type: user_klass.name,
-          source: :user
-
-        # @user.like_topic
-        user_klass.send(:define_method, full_action_name) do |target_or_id|
-          target_id = target_or_id.is_a?(target_klass) ? target_or_id.id : target_or_id
-          result = user_klass.create_action(action_type, target_type: target_klass.name,
+        def define_relations(action)
+          target_klass = action[:target_klass]
+          action_type = action[:action_type]
+          action_name = action[:action_name]
+
+          user_klass = self
+
+          # user, person
+          user_name = user_klass.table_name.underscore.singularize
+
+          # like_topic, follow_user
+          full_action_name = [action_type, action_name].join("_")
+          # like_user, follow_user
+          full_action_name_for_target = [action_type, "by", user_name].join("_")
+          # unlike_topic, unfollow_user
+          unaction_name = "un#{full_action_name}"
+
+          # @target.like_topic_actions, @target.follow_user_actions
+          has_many_name = [full_action_name, "actions"].join("_").to_sym
+          # @target.like_topics, @target.follow_users
+          has_many_through_name = full_action_name.pluralize.to_sym
+
+          # @user.like_by_user_actions, @user.follow_by_user_actions
+          has_many_name_for_target = [full_action_name_for_target, "actions"].join("_").to_sym
+          # @user.like_by_users, @user.follow_by_users
+          has_many_through_name_for_target = full_action_name_for_target.pluralize.to_sym
+
+          has_many_scope = -> {
+            where(action_type: action_type, target_type: target_klass.name, user_type: user_klass.name)
+          }
+
+          # User has_many :like_topic_actions
+          user_klass.send :has_many, has_many_name, has_many_scope,
+            class_name: "Action",
+            foreign_key: "user_id"
+          # User has_many :like_topics
+          user_klass.send :has_many, has_many_through_name,
+            through: has_many_name,
+            source: :target,
+            source_type: target_klass.name
+
+          # Topic has_many :like_user_actions
+          target_klass.send :has_many, has_many_name_for_target, has_many_scope,
+            foreign_key: :target_id,
+            class_name: "Action"
+          # Topic has_many :like_users
+          target_klass.send :has_many, has_many_through_name_for_target,
+            through: has_many_name_for_target,
+            source_type: user_klass.name,
+            source: :user
+
+          # @user.like_topic
+          user_klass.send(:define_method, full_action_name) do |target_or_id|
+            target_id = target_or_id.is_a?(target_klass) ? target_or_id.id : target_or_id
+            result = user_klass.create_action(action_type, target_type: target_klass.name,
+                                                           target_id: target_id,
+                                                           user: self)
+            self.reload
+            result
+          end
+
+          # @user.like_topic?
+          user_klass.send(:define_method, "#{full_action_name}?") do |target_or_id|
+            target_id = target_or_id.is_a?(target_klass) ? target_or_id.id : target_or_id
+            result = user_klass.find_action(action_type, target_type: target_klass.name,
                                                          target_id: target_id,
                                                          user: self)
-          self.reload
-          result
+            result.present?
+          end
+
+          # @user.unlike_topic
+          user_klass.send(:define_method, unaction_name) do |target_or_id|
+            target_id = target_or_id.is_a?(target_klass) ? target_or_id.id : target_or_id
+            result = user_klass.destroy_action(action_type, target_type: target_klass.name,
+                                                            target_id: target_id,
+                                                            user: self)
+            self.reload
+            result
+          end
         end
 
-        # @user.like_topic?
-        user_klass.send(:define_method, "#{full_action_name}?") do |target_or_id|
-          target_id = target_or_id.is_a?(target_klass) ? target_or_id.id : target_or_id
-          result = user_klass.find_action(action_type, target_type: target_klass.name,
-                                                       target_id: target_id,
-                                                       user: self)
-          result.present?
+        def safe_action_opts(opts)
+          opts ||= {}
+          if opts[:user]
+            opts[:user_id] = opts[:user].id
+            opts[:user_type] = opts[:user].class.name
+          end
+          if opts[:target]
+            opts[:target_type] = opts[:target].class.name
+            opts[:target_id] = opts[:target].id
+          end
+          opts
         end
 
-        # @user.unlike_topic
-        user_klass.send(:define_method, unaction_name) do |target_or_id|
-          target_id = target_or_id.is_a?(target_klass) ? target_or_id.id : target_or_id
-          result = user_klass.destroy_action(action_type, target_type: target_klass.name,
-                                                          target_id: target_id,
-                                                          user: self)
-          self.reload
-          result
+        def where_opts(opts)
+          opts.extract!(:action_type, :target_type, :target_id, :user_id, :user_type)
         end
-      end
-
-      def safe_action_opts(opts)
-        opts ||= {}
-        if opts[:user]
-          opts[:user_id] = opts[:user].id
-          opts[:user_type] = opts[:user].class.name
-        end
-        if opts[:target]
-          opts[:target_type] = opts[:target].class.name
-          opts[:target_id] = opts[:target].id
-        end
-        opts
-      end
-
-      def where_opts(opts)
-        opts.extract!(:action_type, :target_type, :target_id, :user_id, :user_type)
-      end
     end
   end
 end

data/lib/action_store/model.rb

@@ -1,11 +1,12 @@
+# frozen_string_literal: true
 module ActionStore
   module Model
     extend ActiveSupport::Concern
 
     included do
       # puts "Initialize ActionStore::Model"
-      belongs_to :target, polymorphic: true
-      belongs_to :user, polymorphic: true
+      belongs_to :target, polymorphic: true, optional: true
+      belongs_to :user, polymorphic: true, optional: true
     end
   end
 end

data/lib/action_store/version.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ActionStore
-  VERSION = "0.3.2"
+  VERSION = "0.3.3"
 end

data/lib/generators/action_store/install_generator.rb

@@ -1,16 +1,17 @@
-require 'rails/generators'
+# frozen_string_literal: true
+require "rails/generators"
 module ActionStore
   module Generators
     class InstallGenerator < Rails::Generators::Base
       desc "Create ActionStore's base files"
-      source_root File.expand_path('../../../../', __FILE__)
+      source_root File.expand_path("../../../../", __FILE__)
 
       def add_initializer
-        template 'config/initializers/action_store.rb', 'config/initializers/action_store.rb'
+        template "config/initializers/action_store.rb", "config/initializers/action_store.rb"
       end
 
       def add_migrations
-        exec('rake action_store:install:migrations')
+        exec("rake action_store:install:migrations")
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: action-store
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors:
 - Jason Lee
@@ -14,9 +14,6 @@ dependencies:
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.2.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5'
@@ -24,12 +21,65 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.2.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5'
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: codecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Store difference kind of actions (Like, Follow, Star, Block ...) in one
   table via ActiveRecord Polymorphic Association.
 email: huacnlee@gmail.com
@@ -71,7 +121,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Store difference kind of actions (Like, Follow, Star, Block ...) in one table.