social_man 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8faa448ec53af875988e037161d8c353f147fa31e65578b9923f5aec922d634a
-  data.tar.gz: 647a1f4dbcc311c1261c60db46f8d6698fa0bceeb8e35462d80c6d7ad9234652
+  metadata.gz: bc565ae17296e2e1570eea93006c687b9eb98a46ecfb7cfa34c590de703e09f8
+  data.tar.gz: f20b035053e73233c20e151bb9a1f84f44e377eccace08d66cbe662f28acb70c
 SHA512:
-  metadata.gz: c8d7159def702ebd429b93a417c943a1fe2c5116d90679a3bc22593ab08ddead64a7b581a5cee214d105e8110c23520b785425d808e0de7b05733949f7ab7233
-  data.tar.gz: f983ac83dcaebdeaacbb79fbc45bceb69795d2b75693ac2d9cf64622392ef4313c766d2a238d18ecfb11bbaf26ab565f0da53899a86217d996097fe4198644a1
+  metadata.gz: 99dc914979f634d4cb22edec6fb2fbfe13ad3b87d8d032c62c0f5d60528753dbcdf6e7ec5050bccb95bdec3962252ad4a83ef138dfcf053795f7f2a6bbe4e7b1
+  data.tar.gz: 3db8524fd964a11eb06b60688ef7426dee3973bedcc56fddb8a2b3dbeb6a036c129a1020312d3453e8c026be8df6defc4989cf240341ff89f1bad8c7fb1ebf36

data/app/models/action.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# Auto generate with social-man gem.
+
 class Action < ActiveRecord::Base
   include SocialMan::ActionModel
 end

data/lib/generators/social_man_generator.rb

@@ -0,0 +1,41 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+class SocialManGenerator < Rails::Generators::Base
+  
+  include Rails::Generators::Migration
+  
+  def self.source_root
+    @source_root ||= File.join(File.dirname(__FILE__), 'templates')
+  end
+
+  def self.next_migration_number(dir)
+    Time.now.utc.strftime("%Y%m%d%H%M%S")
+  end
+  
+  def create_migration_file
+    migration_template 'migration.rb', 'db/migrate/social_man_create_actions.rb',
+                       migration_version: migration_version
+  end
+
+  def create_model
+    template "model.rb", File.join('app/models', "actions.rb")
+  end
+
+  def copy_initializer_file
+    template "initializer.rb", "config/initializers/social_man.rb"
+  end
+
+  private
+
+  def rails5?
+    Rails.version.start_with? '5'
+  end
+
+  def migration_version
+    if rails5?
+      "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
+    end
+  end
+  
+end

data/lib/generators/templates/README

@@ -0,0 +1,8 @@
+Now, you just have to run the migration using rake command:
+
+   rake db:migrate
+
+and you will be able to add the acts_as_action_subject or acts_as_action_object
+method inside models.
+
+===============================================================================

data/lib/generators/templates/initializer.rb

@@ -0,0 +1,4 @@
+SocialMan.configure do |config|
+  # Config actions to be used as social actions
+  # config.actions = [:like, :star, :follow]
+end

data/lib/generators/templates/migration.rb

@@ -0,0 +1,12 @@
+class SocialManCreateActions < ActiveRecord::Migration<%= migration_version %>
+  def change
+    create_table :actions do |t|
+      t.references :action_subject, polymorphic: true
+      t.string :action_type
+      t.string :action_options
+      t.references :action_object, polymorphic: true
+
+      t.timestamps
+    end
+  end
+end

data/lib/generators/templates/model.rb

@@ -0,0 +1,3 @@
+class Action < ApplicationRecord
+  include SocialMan::ActionModel
+end

data/lib/social_man.rb

@@ -1,8 +1,12 @@
 require "social_man/version"
 require "social_man/engine"
 require 'social_man/railtie' if defined?(Rails) && Rails::VERSION::MAJOR >= 3
+require 'social_man/configure'
+require 'social_man/action_thesaurus'
 
 module SocialMan
+  extend Configure
+
   autoload :ActionSubject, 'social_man/action_subject'
   autoload :ActionObject, 'social_man/action_object'
   autoload :ActionModel, 'social_man/action_model'

data/lib/social_man/action_model.rb

@@ -1,11 +1,15 @@
 # frozen_string_literal: true
+
+# 
+# Like, Star
+
 module SocialMan
   module ActionModel
     extend ActiveSupport::Concern
 
     included do
-      belongs_to :subject, polymorphic: true
-      belongs_to :object, polymorphic: true
+      belongs_to :action_subject, polymorphic: true
+      belongs_to :action_object, polymorphic: true
     end
   end
 end

data/lib/social_man/action_object.rb

@@ -7,7 +7,7 @@ module SocialMan
 
     module ClassMethods
       def acts_as_action_object
-        has_many :passive_actions, class_name: 'Action',
+        has_many :passive_actions, class_name: 'Action', as: :action_object,
               dependent: :destroy
 
         include SocialMan::ActionObject::InstanceMethods
@@ -15,13 +15,79 @@ module SocialMan
     end
 
     module InstanceMethods
-      def be_taken_action_by(subject)
-        Action.create subject: subject, object: self
+      def taken_action_by(action_subject, action_type = 'Action')
+        Action.create action_type: action_type, action_subject: action_subject, action_object: self
       end
 
-      def passive_to?(subject)
-        Action.exists? subject: subject, object: self
+      def passive_to?(action_subject, action_type = 'Action')
+        Action.exists? action_type: action_type, action_subject: action_subject, action_object: self
       end
+
+      def undo_action_by(action_subject, action_type = 'Action')
+        Action.where(action_type: action_type, action_subject: action_subject, action_object: self)
+              .destroy_all
+      end
+
+      SocialMan.actions.each do |action|
+        define_method action.passive_action do |action_subject|
+          taken_action_by action_subject, action.type
+        end
+
+        # define_method "#{action.passive_action}!" do |action_subject|
+        #   send action.action, action_subject || raise Exception
+        # end
+
+        define_method "#{action.passive_action}?" do |action_subject|
+          passive_to? action_subject, action.type
+        end
+
+        define_method action.passive_undo do |action_subject|
+          undo_action_by action_subject, action.type
+        end
+
+        # define_method "#{action.passive_undo}!" do |action_subject|
+        #   send action.passive_undo, action_subject || raise Exception
+        # end
+
+        define_method "#{action.passive_undo}?" do |action_subject|
+          !passive_to? action_subject, action.type
+        end
+
+        # todo
+        # define_method action.all_subjects do |action_subject|
+        #   ids = active_actions.pluck(:action_subject_id)
+        #   subject_class.where id: ids
+        # end
+      end
+
+      # subjects_prefix 
+      def method_missing(method_name, *args)
+        action_type, subject_class = find_subject_class method_name.to_s
+
+        if subject_class.nil?
+          super
+        else
+          ids = passive_actions.where(action_type: action_type).pluck(:action_subject_id)
+          subject_class.where id: ids
+        end
+      end
+
+      private
+
+        def find_subject_class(method_name)
+          action_type = ''
+          subject_type = nil
+          SocialMan.actions.each do |action|
+            if method_name.start_with? action.subjects_prefix
+              action_type = action.type
+              subject_name = method_name.remove action.subjects_prefix
+              subject_type = subject_name.singularize.camelize unless subject_name.blank?
+              break
+            end
+          end
+
+          [action_type, subject_type&.constantize]
+        end
     end
 
   end

data/lib/social_man/action_subject.rb

@@ -7,24 +7,87 @@ module SocialMan
 
     module ClassMethods
       def acts_as_action_subject
-        has_many :active_actions, class_name: 'Action',
+        has_many :active_actions, class_name: 'Action', as: :action_subject,
               dependent: :destroy
-        # has_many :action_objects, class_name: 'Action',
-        #         source: :subject,
-        #         through: :active_actions
 
         include SocialMan::ActionSubject::InstanceMethods
       end
     end
 
     module InstanceMethods
-      def take_action_on(object)
-        Action.create subject: self, object: object
+      def take_action_on(action_object, action_type = 'Action')
+        Action.create action_type: action_type, action_subject: self, action_object: action_object
       end
 
-      def active_to?(object)
-        Action.exists? subject: self, object: object
+      def active_to?(action_object, action_type = 'Action')
+        Action.exists? action_type: action_type, action_subject: self, action_object: action_object
       end
+
+      def undo_action_on(action_object, action_type = 'Action')
+        Action.where(action_type: action_type, action_subject: self, action_object: action_object)
+              .destroy_all
+      end
+
+      SocialMan.actions.each do |action|
+        define_method action.action do |action_object|
+          take_action_on action_object, action.type
+        end
+
+        # define_method "#{action.action}!" do |action_object|
+        #   send action.action, action_object || raise Exception
+        # end
+
+        define_method "#{action.action}?" do |action_object|
+          active_to? action_object, action.type
+        end
+
+        define_method action.undo do |action_object|
+          undo_action_on action_object, action.type
+        end
+
+        # define_method "#{action.undo}!" do |action_object|
+        #   send action.undo, action_object || raise Exception
+        # end
+
+        define_method "#{action.undo}?" do |action_object|
+          !active_to? action_object, action.type
+        end
+
+        # todo
+        # define_method action.all_subjects do |action_object|
+        #   ids = active_actions.pluck(:action_object_id)
+        #   object_class.where id: ids
+        # end
+      end
+
+      # objects_prefix 
+      def method_missing(method_name, *args)
+        action_type, object_class = find_object_class method_name.to_s
+
+        if object_class.nil?
+          super
+        else
+          ids = active_actions.where(action_type: action_type).pluck(:action_object_id)
+          object_class.where id: ids
+        end
+      end
+
+      private
+
+        def find_object_class(method_name)
+          action_type = ''
+          object_type = nil
+          SocialMan.actions.each do |action|
+            if method_name.start_with? action.objects_prefix
+              action_type = action.type
+              object_name = method_name.remove action.objects_prefix
+              object_type = object_name.singularize.camelize unless object_name.blank?
+              break
+            end
+          end
+
+          [action_type, object_type&.constantize]
+        end
     end
 
   end

data/lib/social_man/action_thesaurus.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+    # :like      symbole, action
+    # Like       type
+    # like       do action (present_tense)  / like! like?
+    # unlike     undo action (un-)    / unlike! unlike?
+    # liked_by   passive do action (-ed_by)  / liked_by! liked_by?
+    # unliked_by passive undo action (un-*-ed_by)    / unliked_by! unliked_by?
+    # liking_XX  subjects_prefix (progressive tense -ing_) (liking_user, liking_users)
+    # liked_XX   objects_prefix (past_tense -ed_) (liked_article, liked_articles)
+    # likers     all subjects (-ers) liker, all likers
+    # likables   all objects  (-ables) likable, all likables
+
+module SocialMan
+  class ActionThesaurus
+    attr_reader :name, :type, :action, :undo, :passive_action, :passive_undo,
+                :subjects_prefix, :objects_prefix, :all_subjects, :all_objects
+
+    def initialize(action_name, options={})
+      @name = action_name.to_sym
+      name = action_name.to_s
+      @type = options_or_thesaurus(options, :type) || name.camelize
+      @action = options_or_thesaurus(options, :action) || name
+      @undo = options_or_thesaurus(options, :undo) || 'un' + name
+      @passive_action = options_or_thesaurus(options, :passive_action) || name + 'ed_by'
+      @passive_undo = options_or_thesaurus(options, :passive_undo) || 'un' + name + + 'ed_by'
+      @subjects_prefix = options_or_thesaurus(options, :subjects_prefix) || name + 'ing_'
+      @objects_prefix = options_or_thesaurus(options, :objects_prefix) || name + 'ed_'
+      @all_subjects = options_or_thesaurus(options, :all_subjects) || name + 'ers'
+      @all_objects = options_or_thesaurus(options, :all_objects) || name + 'ables'
+    end
+
+    private 
+
+    def options_or_thesaurus(options, key)
+      options[key].presence || fetch_thesaurus(@name, key)
+    end
+
+    def fetch_thesaurus(action_name, key)
+      action = ActionThesaurus.thesaurus[action_name]
+      action.nil? ? nil : action[key]
+    end
+
+    class << self
+      def thesaurus
+        @@thesaurus ||= init_thesaurus
+      end
+
+      def init_thesaurus
+        thesaurus_array = [
+          %w(like unlike liked_by unliked_by liking liked liker likeable),
+          %w(star unstar starred_by unstarred_by starring starred starrer starable),
+          %w(block unblock blocked_by unblocked_by blocking blocked blockers blockable),
+          %w(follow unfollow followed_by unfollowed_by following followed follower followee),
+          %w(vote unvote voted_by unvoted_by voting voted voter votable)
+        ]
+
+        thesaurus = {}
+        thesaurus_array.each do |line|
+          thesaurus[line[0].to_sym] = {
+            name: line[0].to_sym, 
+            type: line[0].camelize,
+            action: line[0],
+            undo: line[1],
+            passive_action: line[2],
+            passive_undo: line[3],
+            subjects_prefix: line[4] + '_',
+            objects_prefix: line[5] + '_',
+            all_subjects: line[6].pluralize,
+            all_objects: line[7].pluralize
+          }
+        end
+
+        thesaurus
+      end
+    end
+  end
+end

data/lib/social_man/configure.rb

@@ -0,0 +1,30 @@
+module SocialMan
+  module Configure
+    # :like      symbole
+    # Like       type
+    # like       action (present_tense)  / like! like?
+    # unlike     reverse action (un-)    / unlike! unlike?
+    # liking_XX  subjects (progressive tense -ing) (liking_users)
+    # liked_XX   objects (past_tense -ed) (liked_articles)
+    # liker      all subjects (-er)
+    # likable    all objects  (-able)
+    
+    @@actions = []
+
+    def configure
+      yield self if block_given?
+    end
+
+    def actions=(actions)
+      actions.each { |action| @@actions << SocialMan::ActionThesaurus.new(action) }
+    end
+
+    def actions
+      @@actions
+    end
+
+    def define_action(action, **options)
+      @@actions << SocialMan::ActionThesaurus.new(action, options)
+    end
+  end
+end

data/lib/social_man/version.rb

@@ -1,3 +1,3 @@
 module SocialMan
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: social_man
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - John Hu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-09 00:00:00.000000000 Z
+date: 2018-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.2.1
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.2.1
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  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_bot
   requirement: !ruby/object:Gem::Requirement
@@ -107,10 +121,17 @@ files:
 - app/assets/config/social_man_manifest.js
 - app/models/action.rb
 - config/routes.rb
+- lib/generators/social_man_generator.rb
+- lib/generators/templates/README
+- lib/generators/templates/initializer.rb
+- lib/generators/templates/migration.rb
+- lib/generators/templates/model.rb
 - lib/social_man.rb
 - lib/social_man/action_model.rb
 - lib/social_man/action_object.rb
 - lib/social_man/action_subject.rb
+- lib/social_man/action_thesaurus.rb
+- lib/social_man/configure.rb
 - lib/social_man/engine.rb
 - lib/social_man/railtie.rb
 - lib/social_man/version.rb