action_plugin 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6fc41d4690345bed33ece11dbc300ea84bb34217
+  data.tar.gz: ca7388bbe7b8bf3238d5405d97e42cec38c95e18
+SHA512:
+  metadata.gz: baef0abb6945a343bea95446b62128729baab4abebee7181d241ac5808d1cc0a311bb6448716856b1ff42f156ea768064b9b9ad541f3f795427d9f16995d454c
+  data.tar.gz: 60a3ad99e940b77a5374d55e5a18d98d80119d90eecb4b1067ef03fda5cbab076aff64c868e80a226b80659e2d5f0367d08684fab2ee0b3b905dfc5852e6e3d7

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.16.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at baodongdong@tigerjoys.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 baodongdong
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,84 @@
+# ActionPlugin
+
+Plugin different kind of actions Like, Follow, Star ...
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'action_plugin'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install action_plugin
+
+## Usage
+
+Generate Migrations:
+
+```ruby
+$ rails g action_store:install
+```
+
+```ruby
+migration 20170208024704_create_actions.rb from action_plugin
+```
+
+## Define Actions
+
+app/models/user.rb
+
+```ruby
+class Subject < ActiveRecord::Base
+  action_plugin subject_type, action_type, target_type
+end
+```
+
+
+for example:
+
+```ruby
+class User < ActiveRecord::Base
+  action_plugin :User, :like, :Post
+  action_plugin :User, :collection, :Topic
+  action_plugin :Member, :like, :Topic
+end
+```
+
+## some instance methods:
+
+```ruby
+action_target_actions
+
+action_targets
+
+action_subject_actions
+
+action_subjects
+
+action_target?
+
+for example:
+
+action_plugin :User, :like, :Post -> generate instance methods:
+
+@user.like_post_actions
+
+@user.like_posts
+
+@post.like_user_actions
+
+@post.like_users
+
+@user.like_post @post
+
+@user.unlike_post @post
+
+@user.like_post? @post
+```

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/action_plugin.gemspec

@@ -0,0 +1,34 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+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.summary       = %q{Plugin different kind of actions Like, Follow, Star ...}
+  spec.description   = %q{Plugin different kind of actions Like, Follow, Star ...}
+  spec.homepage      = "https://github.com/baodongdongCK/action_plugin"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "rails", "~> 4.2.0"
+end

data/db/migrate/create_actions.rb

@@ -0,0 +1,16 @@
+class CreateActions < ActiveRecord::Migration[5.0]
+  def change
+    create_table :actions do |t|
+      t.integer :subject_id
+      t.string :subject_type
+      t.string :action_type
+      t.string :target_type
+      t.integer :target_id
+
+      t.timestamps
+    end
+
+    add_index :actions, %w[subject_id subject_type action_type]
+    add_index :actions, %w[target_id target_type action_type]
+  end
+end

data/lib/action_plugin.rb

@@ -0,0 +1,10 @@
+require "action_plugin/version"
+require "action_plugin/mixin"
+require "action_plugin/action"
+
+module ActionPlugin
+end
+
+ActiveSupport.on_load(:active_record) do
+  include ActionPlugin::Mixin
+end

data/lib/action_plugin/action.rb

@@ -0,0 +1,4 @@
+class Action < ActiveRecord::Base
+  belongs_to :subject, polymorphic: true
+  belongs_to :target, polymorphic: true
+end

data/lib/action_plugin/mixin.rb

@@ -0,0 +1,92 @@
+module ActionPlugin
+  module Mixin
+    extend ActiveSupport::Concern
+
+    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_type] = opts[:subject].class.name
+      opts
+    end
+
+    def format_opts opts
+      opts.extract!(:subject_id, :subject_type, :action_type, :target_type, :target_id)
+    end
+
+    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_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 }
+      end
+
+      def action_plugin(subject_type, action_type, target_type)
+        initialize_params(subject_type, action_type, target_type)
+        define_relations
+      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])
+        }
+        @subject_class.send(:has_many, action_target_actions, has_many_scope,
+                            class_name: "Action", foreign_key: "subject_id")
+        @subject_class.send(:has_many, action_targets, through: action_target_actions,
+                            source: :target, source_type: @target_type)
+        @target_class.send(:has_many, action_subject_actions, has_many_scope,
+                            class_name: "Action", foreign_key: "target_id")
+        @target_class.send(:has_many, action_subjects, through: action_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}"
+        action_target_mark = "#{action_target}?"
+
+        @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,
+                                    action_type: options[:action_type], target_id: target_id,
+                                    target_type: options[:target_type]
+                                  )
+        end
+
+        @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.present?
+        end
+
+        @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.destroy
+        end
+
+        @subject_class.send(:define_method, "find_action") do |opts = {}|
+          opts = validate_opts(opts)
+          action = Action.find_by(format_opts(opts))
+          action
+        end
+      end
+
+    end
+  end
+end

data/lib/action_plugin/version.rb

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

data/lib/generators/action_plugin/install_generator.rb

@@ -0,0 +1,15 @@
+require 'rails/generators'
+
+module ActionPlugin
+  module Generators
+    class InstallGenerator <  Rails::Generators::Base
+      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"
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: action_plugin
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- baodongdong
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-12-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+description: Plugin different kind of actions Like, Follow, Star ...
+email:
+- baodongdong@tigerjoys.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- 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
+homepage: https://github.com/baodongdongCK/action_plugin
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Plugin different kind of actions Like, Follow, Star ...
+test_files: []