action_plugin 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6fc41d4690345bed33ece11dbc300ea84bb34217
-  data.tar.gz: ca7388bbe7b8bf3238d5405d97e42cec38c95e18
+  metadata.gz: 71d13a846edc92f3fd37a6d23201148b74652876
+  data.tar.gz: 497eaea757e2a373ff994642238a56da153124de
 SHA512:
-  metadata.gz: baef0abb6945a343bea95446b62128729baab4abebee7181d241ac5808d1cc0a311bb6448716856b1ff42f156ea768064b9b9ad541f3f795427d9f16995d454c
-  data.tar.gz: 60a3ad99e940b77a5374d55e5a18d98d80119d90eecb4b1067ef03fda5cbab076aff64c868e80a226b80659e2d5f0367d08684fab2ee0b3b905dfc5852e6e3d7
+  metadata.gz: 7a0cde949a1ba30e95efc762b30708efab0594c31c69d88038b0f9498ea68621f1dcd6e8b191e5ebf67f4778e779cb979937b61f80445ab88eef18586443306a
+  data.tar.gz: 7285d2df12f0e0e4df85600d7498132d41c459807258b1146dce62aed019a5c5db480099ce78643143a729bf0a3c3c948ca6266c72e68c55031882d2c00fd57d

data/README.md

@@ -23,11 +23,15 @@ Or install it yourself as:
 Generate Migrations:
 
 ```ruby
-$ rails g action_store:install
+$ rails g action_plugin:install
 ```
 
 ```ruby
-migration 20170208024704_create_actions.rb from action_plugin
+create migration 20170208024704_create_actions.rb
+```
+
+```ruby
+rails db:migrate
 ```
 
 ## Define Actions
@@ -54,31 +58,80 @@ end
 ## some instance methods:
 
 ```ruby
-action_target_actions
+for example one:
 
-action_targets
+# Users like topic can be defined as follows.
+class User < ActiveRecord::Base
+  action_plugin :User, :like, :Topic
+end
 
-action_subject_actions
+If you have the definition above the following methods are generated
 
-action_subjects
+# Returns the actions of all the topics that this user likes
+@user.likeing_topic_actions
 
-action_target?
+# Return to all the topics that this user likes
+@user.likeing_topics
 
-for example:
+# Return to all the topic id that this user likes
+@user.likeing_topic_ids
+
+# Return all user actions that like this topic
+@topic.likeed_user_actions
+
+# Returns all users who like the topic
+@topic.likeed_users
+
+# Returns all user id who like the topic
+@topic.likeed_user_ids
+
+# Users like to create an action record
+@user.like_topic @topic
+
+#The user does not like the topic to delete an action record
+@user.unlike_topic @topic
+
+#Do users like the theme
+@user.like_topic? @topic
+
+```
+
+```ruby
+
+for example two:
+
+# Users can follow the definition of other people.
+class User < ActiveRecord::Base
+  action_plugin :User, :follow, :User
+end
+
+If you have the definition above the following methods are generated
+
+# Returns current_user following other people relations
+current_user.following_user_actions
+
+# Return current_user following all users
+current_user.following_users
 
-action_plugin :User, :like, :Post -> generate instance methods:
+# Return current_user following all user ids
+current_user.following_user_ids
 
-@user.like_post_actions
+# Return All user relationships that the user is concerned with
+user.followed_user_actions
 
-@user.like_posts
+# Returns All users that the user is concerned about.
+user.followed_users
 
-@post.like_user_actions
+# Returns all user followed user ids
+user.followed_user_ids
 
-@post.like_users
+# Users follow to create an relation
+current_user.follow_user user
 
-@user.like_post @post
+#The user does not unfollow the user to delete an relation
+current_user.unfollow_user user
 
-@user.unlike_post @post
+#Do users follow the theme
+current_user.follow_user? user
 
-@user.like_post? @post
 ```

data/action_plugin.gemspec

@@ -6,8 +6,8 @@ require "action_plugin/version"
 Gem::Specification.new do |spec|
   spec.name          = "action_plugin"
   spec.version       = ActionPlugin::VERSION
-  spec.authors       = ["baodongdong"]
-  spec.email         = ["baodongdong@tigerjoys.com"]
+  spec.authors       = ["baodongdongCK"]
+  spec.email         = ["bao1214063293@gmail.com"]
 
   spec.summary       = %q{Plugin different kind of actions Like, Follow, Star ...}
   spec.description   = %q{Plugin different kind of actions Like, Follow, Star ...}

data/lib/action_plugin/mixin.rb

@@ -5,7 +5,7 @@ module ActionPlugin
     def validate_opts opts = {}
       return false if opts[:subject].blank? || opts[:action_type].blank?
       return false if opts[:target_id].blank? || opts[:target_type].blank?
-      opts[:subject_id] = opts[:subject].id
+      opts[:subject_id]   = opts[:subject].id
       opts[:subject_type] = opts[:subject].class.name
       opts
     end
@@ -16,14 +16,18 @@ module ActionPlugin
 
     module ClassMethods
       def initialize_params(subject_type, action_type, target_type)
-        @subject_type = subject_type.to_s.classify
-        @action_type = action_type.to_s
-        @target_type = target_type.to_s.classify
+        @subject_type  = subject_type.to_s.classify
+        @action_type   = action_type.to_s
+        @actioning     = "#{@action_type}ing"
+        @actioned      = "#{@action_type}ed"
+        @target_type   = target_type.to_s.classify
         @subject_class = @subject_type.constantize
-        @target_class = @target_type.constantize
-        @subject = @subject_type.downcase
-        @target = @target_type.downcase
-        @options = { subject_type: @subject_type, action_type: @action_type, target_type: @target_type, target_class: @target_class }
+        @target_class  = @target_type.constantize
+        @subject       = @subject_type.downcase
+        @target        = @target_type.downcase
+        @options       = { subject_type: @subject_type, action_type: @action_type,
+          target_type: @target_type, target_class: @target_class
+        }
       end
 
       def action_plugin(subject_type, action_type, target_type)
@@ -32,31 +36,39 @@ module ActionPlugin
       end
 
       def define_relations
-        options = @options
-        action_target_actions = [@action_type, @target, 'actions'].join('_').to_sym
-        action_targets = [@action_type, @target].join('_').pluralize.to_sym
-        action_subject_actions = [@action_type, @subject, 'actions'].join('_').to_sym
-        action_subjects = [@action_type, @subject].join('_').pluralize.to_sym
-        has_many_scope = -> {
-          where(subject_type: options[:subject_type], action_type: options[:action_type], target_type: options[:target_type])
+        options                  = @options
+        actioning_target_actions = [@actioning, @target, :actions].join('_').to_sym
+        actioning_targets        = [@actioning, @target].join('_').pluralize.to_sym
+        actioned_subject_actions = [@actioned, @subject, :actions].join('_').to_sym
+        actioned_subjects        = [@actioned, @subject].join('_').pluralize.to_sym
+        has_many_scope           = -> { where(subject_type: options[:subject_type],
+          action_type: options[:action_type], target_type: options[:target_type])
         }
-        @subject_class.send(:has_many, action_target_actions, has_many_scope,
+
+        # like following_user_actions
+        @subject_class.send(:has_many, actioning_target_actions, has_many_scope,
                             class_name: "Action", foreign_key: "subject_id")
-        @subject_class.send(:has_many, action_targets, through: action_target_actions,
+        # like following_users
+        @subject_class.send(:has_many, actioning_targets, through: actioning_target_actions,
                             source: :target, source_type: @target_type)
-        @target_class.send(:has_many, action_subject_actions, has_many_scope,
+
+        # like followed_user_actions
+        @target_class.send(:has_many, actioned_subject_actions, has_many_scope,
                             class_name: "Action", foreign_key: "target_id")
-        @target_class.send(:has_many, action_subjects, through: action_subject_actions,
+
+        # like followed_users
+        @target_class.send(:has_many, actioned_subjects, through: actioned_subject_actions,
                             source: :subject, source_type: @subject_type)
         define_some_methods
       end
 
       def define_some_methods
-        options = @options
-        action_target = [@action_type, @target].join("_")
-        unaction_target = "un#{action_target}"
+        options            = @options
+        action_target      = [@action_type, @target].join("_")
+        unaction_target    = "un#{action_target}"
         action_target_mark = "#{action_target}?"
 
+        # define_method like follow_user
         @subject_class.send(:define_method, action_target) do |target_or_id|
           target_id = target_or_id.is_a?(options[:target_class]) ? target_or_id.id : target_or_id
           Action.find_or_create_by( subject_id: self.id, subject_type: self.class.name,
@@ -65,23 +77,26 @@ module ActionPlugin
                                   )
         end
 
+        # define_method like follow_user?
         @subject_class.send(:define_method, action_target_mark) do |target_or_id|
           target_id = target_or_id.is_a?(options[:target_class]) ? target_or_id.id : target_or_id
-          action = find_action(subject: self, action_type: options[:action_type],
-                                target_id: target_id, target_type: options[:target_type]
-                              )
+          action    = find_action(subject: self, action_type: options[:action_type],
+                                  target_id: target_id, target_type: options[:target_type]
+                                 )
           action.present?
         end
 
+        # define_method like unfollow_user
         @subject_class.send(:define_method, unaction_target) do |target_or_id|
           target_id = target_or_id.is_a?(options[:target_class]) ? target_or_id.id : target_or_id
-          action = find_action(subject: self, action_type: options[:action_type],
-                                target_id: target_id, target_type: options[:target_type])
+          action    = find_action(subject: self, action_type: options[:action_type],
+                                  target_id: target_id, target_type: options[:target_type]
+                                 )
           action.destroy
         end
 
         @subject_class.send(:define_method, "find_action") do |opts = {}|
-          opts = validate_opts(opts)
+          opts   = validate_opts(opts)
           action = Action.find_by(format_opts(opts))
           action
         end

data/lib/action_plugin/version.rb

@@ -1,3 +1,3 @@
 module ActionPlugin
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

data/lib/generators/action_plugin/install_generator.rb

@@ -1,15 +1,35 @@
 require 'rails/generators'
+require 'rails/generators/migration'
 
 module ActionPlugin
   module Generators
-    class InstallGenerator <  Rails::Generators::Base
+    class InstallGenerator <  Rails::Generators::NamedBase
       desc "Create ActionPlugin's action migration file"
-      source_root File.expand_path('../../../../db/migrate', __FILE__)
 
-      def add_migration
-        current_time = Time.now.strftime("%Y%m%d%H%M%S")
-        copy_file "create_actions.rb", "db/migrate/#{current_time}_create_actions.rb"
+      argument :name, type: :string, default: 'actions'
+      include Rails::Generators::Migration
+      source_root File.expand_path('../templates', __FILE__)
+
+      def self.next_migration_number(dirname)
+        if ActiveRecord::Base.timestamped_migrations
+          [Time.now.utc.strftime("%Y%m%d%H%M%S"), "%.14d"].max
+        else
+          SchemaMigration.normalize_migration_number(dirname)
+        end
+      end
+
+      def create_action
+        migration_template 'migration.rb', 'db/migrate/create_actions.rb', migration_version: migration_version
+      end
+
+      def rails5?
+        Rails.version.start_with? '5'
+      end
+
+      def migration_version
+        "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]" if rails5?
       end
+
     end
   end
 end

data/{db/migrate/create_actions.rb → lib/generators/action_plugin/templates/migration.rb}

@@ -1,4 +1,4 @@
-class CreateActions < ActiveRecord::Migration[5.0]
+class CreateActions < ActiveRecord::Migration<%= migration_version %>
   def change
     create_table :actions do |t|
       t.integer :subject_id

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: action_plugin
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
-- baodongdong
+- baodongdongCK
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-29 00:00:00.000000000 Z
+date: 2018-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -26,7 +26,7 @@ dependencies:
         version: 4.2.0
 description: Plugin different kind of actions Like, Follow, Star ...
 email:
-- baodongdong@tigerjoys.com
+- bao1214063293@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -38,12 +38,12 @@ files:
 - README.md
 - Rakefile
 - action_plugin.gemspec
-- db/migrate/create_actions.rb
 - lib/action_plugin.rb
 - lib/action_plugin/action.rb
 - lib/action_plugin/mixin.rb
 - lib/action_plugin/version.rb
 - lib/generators/action_plugin/install_generator.rb
+- lib/generators/action_plugin/templates/migration.rb
 homepage: https://github.com/baodongdongCK/action_plugin
 licenses:
 - MIT
@@ -64,7 +64,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Plugin different kind of actions Like, Follow, Star ...