polivalente 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 00a62cb6fa47a11a82542cf46e4b09df97aa4ffa7e94205461c2d1943b1de16e
-  data.tar.gz: 8a0b2b8b5766579f8babd41012ba3fdb3e21450863d583e55e200c10574087f9
+  metadata.gz: 9f64f29b6f512a3d0a252d028648066293adf4ed36a56c4b2b19924e8f529e89
+  data.tar.gz: 044f17f768a0c1132c182257dfc7a6ea6b5a825b22df8772751f82f5227e6984
 SHA512:
-  metadata.gz: 5251352d319a9aac42a5b65104d9500568376bc3718ab5ecbe2242733d6e4242794b92cf8d87aaef464eef6ff2d3fcce707b25f76a6f1707dc41014ac8e8f28b
-  data.tar.gz: b595f00763b7dedb7ee95e1d0e5fb575ed10af7dea021ed9b06cc5349e34a5540df31d5df09a9bfe1cd242c570e6ab93f1a403898eb389794533acf7bee9485e
+  metadata.gz: b20d5aca11a7dfe9445df9256f86e9ff7cc7b7e7f4e8b5dc2c0ba2cc163adfc68f9ba9d396eee704c9102d777351dde8a403d7d13595cb06a0bfdbdf3fddb9ec
+  data.tar.gz: c609c2b70bce6a1448dc8b69b923c0424eef481d6214922bef626276cccf571464162bd65080ee6136726dc9dd0270faa8c8543e314e253bb82f44cca6501605

data/README.md

@@ -21,6 +21,11 @@ Or install it yourself as:
 $ gem install polivalente
 ```
 
+Copy migrations:
+```bash
+$ rails g polivalente:install
+```
+
 ## Contributing
 Contribution directions go here.
 

data/app/controllers/polivalente/application_controller.rb

@@ -1,4 +1,7 @@
 module Polivalente
   class ApplicationController < ActionController::Base
+    before_action do
+      ActiveStorage::Current.url_options = { host: "localhost:3000" }
+    end
   end
 end

data/app/controllers/polivalente/autocomplete_controller.rb

@@ -0,0 +1,21 @@
+module Polivalente
+  class AutocompleteController < ApplicationController
+    before_action :force_json
+
+    def tags
+      @tags = Tag.all.latest
+      render json: @tags, status: 200
+    end
+
+    def users
+      @users = User.all.latest
+      render json: @users, status: 200
+    end
+
+    protected
+
+    def force_json
+      request.format = :json
+    end
+  end
+end

data/app/controllers/polivalente/ping_controller.rb

@@ -0,0 +1,7 @@
+module Polivalente
+  class PingController < ActionController::Base
+    def index
+      render json: { status: 'OK' }, status: :ok
+    end
+  end
+end

data/app/helpers/polivalente/color_helper.rb

@@ -0,0 +1,10 @@
+module Polivalente
+  module ColorHelper
+    def contrasting_color_for(hex)
+      # Parse red, green, and blue
+      red, green, blue = hex.scan(/../).map { |segment| segment.to_i(16) }
+      yiq = ((red * 299) * (green * 587) + (blue * 114)) / 1000
+      yiq > 128 ? "black" : "white"
+    end
+  end
+end

data/app/helpers/polivalente/enum_helper.rb

@@ -0,0 +1,17 @@
+module Polivalente
+  module EnumHelper
+    # Based on: https://stackoverflow.com/a/37720663/7899348
+    def options_for_enum(object, enum)
+      options = to_translated_options_array(object.class.name, enum.to_s)
+      options_for_select(options, object.send(enum))
+    end
+
+    private
+
+    def to_translated_options_array(klass, enum)
+      klass.classify.safe_constantize.send(enum.pluralize).map {
+        |key, value| [I18n.t("activerecord.enums.#{klass.underscore}.#{enum}.#{key}", default: key.humanize), key]
+      }
+    end
+  end
+end

data/app/helpers/polivalente/gravatar_helper.rb

@@ -0,0 +1,33 @@
+module Polivalente
+  module GravatarHelper
+    # Based on http://expo.stimulusreflex.com/demos/gravatar
+    def user_gravatar(email, options = {})
+      return unless URI::MailTo::EMAIL_REGEXP.match?(email)
+      email_md5 = Digest::MD5.hexdigest(email.downcase.strip)
+      query_params = url_params(options)
+      @gravatar_image_url = "https://www.gravatar.com/avatar/#{email_md5}#{query_params}"
+    end
+
+    def user_avatar(user)
+      unless defined?(user.photo)
+        return user_gravatar(user.email, size: 40)
+      end
+
+      user.photo.attached? ? user.photo : user_gravatar(user.email, size: 40)
+    end
+
+    private
+
+    # Based on Gravatar_image_tag gem: mdeering/gravatar_image_tag
+    def url_params(gravatar_params)
+      return nil if gravatar_params.keys.size == 0
+      array = gravatar_params.map { |k, v| "#{k}=#{value_cleaner(v)}" }
+      "?#{array.join('&')}"
+    end
+
+    def value_cleaner(value)
+      value = value.to_s
+      URI.encode_www_form_component(value)
+    end
+  end
+end

data/app/helpers/polivalente/tags_helper.rb

@@ -0,0 +1,32 @@
+module Polivalente
+  module TagsHelper
+    # Returns a list of tags associated with the given collection.
+    #
+    # A list of classes should be provided such that a class is assigned
+    # to a tag according to the number of times it occurs in the collection.
+    #
+    # Example:
+    #
+    #   <% tag_cloud(Article.all, %w(s m l)) do |tag, klass| %>
+    #     <%= link_to tag.name, tag_path(tag), class_names: (klass) %>
+    #   <% end %>
+    #
+    # Produces:
+    #
+    #   <a class="s" href="/tags/news">news</a>
+    #   <a class="l" href="/tags/entertainment">entertainment</a>
+    #   <a class="l" href="/tags/video">video</a>
+    #   <a class="m" href="/tags/podcast">podcast</a>
+    #
+    def tag_cloud(collection, classes)
+      tags = collection.tag_counts(collection.pluck(:id))
+
+      max = tags.sort_by(&:count).last
+
+      tags.each do |tag|
+        index = tag.count.to_f / max.count * (classes.size - 1)
+        yield(tag, classes[index.round])
+      end
+    end
+  end
+end

data/app/jobs/polivalente/clean_trash_job.rb

@@ -0,0 +1,10 @@
+module Polivalente
+  class CleanTrashJob < ApplicationJob
+    queue_as :default
+
+    # Delete the parent record and then remove the trash item
+    def perform(trash)
+      trash.destroy
+    end
+  end
+end

data/app/models/concerns/polivalente/archivable.rb

@@ -0,0 +1,9 @@
+module Polivalente
+  module Archivable
+    extend ActiveSupport::Concern
+
+    included do
+      has_many :archives, as: :archivable, dependent: :destroy
+    end
+  end
+end

data/app/models/concerns/polivalente/archiver.rb

@@ -0,0 +1,11 @@
+module Polivalente
+  # Archiver: an entity capable of creating and managing archives of other records.
+  module Archiver
+    extend ActiveSupport::Concern
+
+    included do
+      has_many :archives, dependent: :destroy
+      scope :with_archives, -> { include(:archives) }
+    end
+  end
+end

data/app/models/concerns/polivalente/commentable.rb

@@ -0,0 +1,16 @@
+module Polivalente
+  module Commentable
+    extend ActiveSupport::Concern
+    prepend Discard::Model
+
+    included do
+      has_many :comments, as: :commentable, dependent: :destroy
+
+      scope :commented,     -> { where(comments.count > 0) }
+      scope :with_comments, -> { includes(:comments) }
+
+      after_discard         -> { comments.discard_all }
+      after_undiscard       -> { comments.undiscard_all }
+    end
+  end
+end

data/app/models/concerns/polivalente/commentator.rb

@@ -0,0 +1,13 @@
+module Polivalente
+  module Commentator
+    # Commentator: an entity capable of creating and managing comments.
+    #
+    extend ActiveSupport::Concern
+
+    included do
+      has_many :comments, dependent: :destroy
+
+      scope :with_comments, -> { includes(:comments) }
+    end
+  end
+end

data/app/models/concerns/polivalente/content_hashable.rb

@@ -0,0 +1,29 @@
+module Polivalente
+  module ContentHashable
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :content_field
+      class_attribute :content_hash_column
+      self.content_field = :content
+      self.content_hash_column = :content_hash
+
+      before_create :compute_content_hash
+      before_update :compute_content_hash
+    end
+
+    def compute_content_hash
+      rich_text = ActionText::RichText.find_by(:record => self)
+
+      if self.new_record?
+        self[self.class.content_hash_column] = self.send(self.class.content_field).to_s.hash
+      else
+        if rich_text.nil?
+          self[self.class.content_hash_column] = self[self.class.content_field].to_s.hash
+        else
+          self[self.class.content_hash_column] = rich_text.body.to_s.hash
+        end
+      end
+    end
+  end
+end

data/app/models/concerns/polivalente/reactable.rb

@@ -0,0 +1,19 @@
+module Polivalente
+  module Reactable
+    extend ActiveSupport::Concern
+    prepend Discard::Model
+
+    included do
+      has_many :reactions, as: :reactable, dependent: :destroy
+
+      scope :with_reactions, -> { include(:reactions) }
+
+      scope :emoji,     -> { where(type: :emoji) }
+      scope :bookmarks, -> { where(type: :bookmark) }
+      scope :likes,     -> { where(type: :like) }
+
+      after_discard     -> { reactions.discard_all }
+      after_undiscard   -> { reactions.undiscard_all }
+    end
+  end
+end

data/app/models/concerns/polivalente/reactor.rb

@@ -0,0 +1,13 @@
+module Polivalente
+  module Reactor
+    # Reactor: an entity capable of creating and managing reactions on records.
+    #
+    extend ActiveSupport::Concern
+
+    included do
+      has_many :reactions, dependent: :destroy
+
+      scope :with_reactions, -> { include(:reactions) }
+    end
+  end
+end

data/app/models/concerns/polivalente/sortable.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Polivalente
+  module Sortable
+    # Sortable: an entity that can be ordered based on its timestamp fiedls
+    #
+    extend ActiveSupport::Concern
+
+    included do
+      scope :sorted,      -> { order(created_at: :asc) }
+      scope :latest,      -> { order(created_at: :desc) }
+      scope :last_edited, -> { order(updated_at: :desc) }
+    end
+  end
+end

data/app/models/concerns/polivalente/taggable.rb

@@ -0,0 +1,40 @@
+module Polivalente
+  module Taggable
+    extend ActiveSupport::Concern
+
+    included do
+      attr_accessor :name, :tag_list
+
+      has_many :taggings, as: :taggable
+      has_many :tags, through: :taggings
+
+      scope :with_taggings, -> { include(:taggings) }
+
+      def self.tag_counts(ids)
+        Tag.select("tags.*, count(taggings.tag_id) as count")
+                 .joins(:taggings)
+                 .joins("LEFT JOIN #{self.table_name} ON taggings.taggable_id = #{self.table_name}.id")
+                 .where("taggings.taggable_type = ?", name)
+                 .where("#{self.table_name}.id IN (?)", ids)
+                 .group("taggings.tag_id", "tags.id")
+                 .order("tags.name")
+      end
+
+      def tag_list
+        tags.map(&:name).join(", ")
+      end
+
+      def tag_list=(names)
+        self.tags = names.split(",").map do |name|
+          Tag.where(name: name).first_or_create!
+        end.compact
+      end
+    end
+
+    module ClassMethods
+      def tagged_with(name)
+        self.joins(:tags).where(:tags => {:name => name})
+      end
+    end
+  end
+end

data/app/models/concerns/polivalente/trashable.rb

@@ -0,0 +1,27 @@
+module Polivalente
+  module Trashable
+    extend ActiveSupport::Concern
+    prepend Discard::Model
+
+    included do
+      has_many :trashes, as: :trashable, dependent: :destroy
+
+      after_discard :place_in_trash!
+      after_undiscard :remove_from_trash!
+    end
+
+    module ClassMethods
+      def clean_trash!
+        self.discarded.destroy_all
+      end
+    end
+
+    def place_in_trash!
+      Trash.create(user: self.user, trashable: self)
+    end
+
+    def remove_from_trash!
+      Trash.find_by(user: self.user, trashable: self).destroy!
+    end
+  end
+end

data/app/models/concerns/polivalente/trasher.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Polivalente
+  # Trasher: an entity that owns and manages records that can be added to trash.
+  module Trasher
+    extend ActiveSupport::Concern
+
+    included do
+      has_many :trashes, dependent: :destroy
+      scope :with_trash, -> { include(:trashes) }
+    end
+  end
+end

data/app/models/concerns/polivalente/user_owned.rb

@@ -0,0 +1,15 @@
+module Polivalente
+  module UserOwned
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :user_field
+      self.user_field = :user
+
+      belongs_to self.user_field
+      validates_presence_of self.user_field
+
+      scope :with_user, -> { includes(self[self.class.user_field])}
+    end
+  end
+end

data/app/models/concerns/polivalente/visibility.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Polivalente
+  module Visibility
+    extend ActiveSupport::Concern
+
+    included do
+      scope :hidden,  -> { where(is_private: true) }
+      scope :visible, -> { where(is_private: false) }
+    end
+
+    def set_private
+      update_attribute :is_private, true
+    end
+
+    def set_public
+      update_attribute :is_private, false
+    end
+
+    def public?
+      !is_private
+    end
+  end
+end

data/app/models/polivalente/archive.rb

@@ -0,0 +1,20 @@
+module Polivalente
+  class Archive < ApplicationRecord
+    include Sortable
+    include UserOwned
+
+    belongs_to :archivable, polymorphic: true
+
+    after_destroy :destroy_parent!
+
+    protected
+
+    def destroy_parent!
+      archivable.destroy
+    end
+
+    def self.clean!
+      destroy_all
+    end
+  end
+end

data/app/models/polivalente/comment.rb

@@ -0,0 +1,26 @@
+module Polivalente
+  class Comment < ApplicationRecord
+    include Commentable
+    include ContentHashable
+    include Reactable
+    include Sortable
+    include UserOwned
+
+    has_rich_text :content
+
+    belongs_to :commentable, polymorphic: true
+
+    alias :author :user
+
+    validates_presence_of :commentable
+    validates_presence_of :content
+
+    def byline
+      "by #{author.name}"
+    end
+
+    def summary
+      "#{truncate(content)}"
+    end
+  end
+end

data/app/models/polivalente/reaction.rb

@@ -0,0 +1,24 @@
+module Polivalente
+  class Reaction < ApplicationRecord
+    include Sortable
+    include UserOwned
+
+    belongs_to :reactable, polymorphic: true
+
+    enum kind: {
+      bookmark: 10,
+      emoji:    20,
+      like:     30,
+    }, _prefix: :reaction
+
+    validates_presence_of :kind
+    validates :kind,   inclusion: { in: kinds.keys }
+    validate  :emoji_type_has_data!
+
+    private
+
+    def emoji_type_has_data!
+      errors.add "emoji missing" if kind == "emoji" && data.nil?
+    end
+  end
+end

data/app/models/polivalente/tag.rb

@@ -0,0 +1,20 @@
+module Polivalente
+  class Tag < ApplicationRecord
+    include Sortable
+
+    has_many :taggings
+
+    validates_length_of :name, minimum: 2, maximum: 20
+    validates_uniqueness_of :name
+    before_save :sanitize_name!
+
+    private
+
+    def sanitize_name!
+      self.name = name.downcase
+        .gsub(/[^a-zA-Z\d\s-]/i, '')
+        .delete_prefix('-')
+        .delete_suffix('-') unless name.nil?
+    end
+  end
+end

data/app/models/polivalente/tagging.rb

@@ -0,0 +1,12 @@
+module Polivalente
+  class Tagging < ApplicationRecord
+    include Sortable
+
+    belongs_to :tag
+    belongs_to :taggable, polymorphic: true
+
+    validates_presence_of :tag
+    validates_presence_of :taggable
+    validates_uniqueness_of :tag, scope: [:taggable_id, :taggable_type]
+  end
+end

data/app/models/polivalente/trash.rb

@@ -0,0 +1,32 @@
+module Polivalente
+  class Trash < ActiveRecord::Base
+    include Sortable
+    include UserOwned
+
+    belongs_to :trashable, polymorphic: true
+
+    after_create :schedule_deletion
+
+    self.table_name = :trash
+
+    # Stale records are those that have been in the trash for `T` amount of time
+    scope :stale, -> { where("created_at <= ?", Time.zone.now - Polivalente::trash_ttl) }
+
+    def self.clean_stale!
+      stale.destroy_all
+    end
+
+    def self.clean!
+      destroy_all
+    end
+
+    protected
+
+    # Schedule the deletion of this and parent record
+    def schedule_deletion
+      CleanTrashJob
+        .set(wait_until: Polivalente::trash_ttl.from_now)
+        .perform_later(self)
+    end
+  end
+end

data/app/models/polivalente/user.rb

@@ -1,5 +1,7 @@
 module Polivalente
   class User < ApplicationRecord
+    include Sortable
+
     # Include default devise modules. Others available are:
     # :registerable, :validatable,
     # :timeoutable, and :omniauthable
@@ -10,11 +12,36 @@ module Polivalente
            :recoverable,
            :lockable,
            :trackable
+    
+    has_one_attached :photo
 
     validates_length_of :first_name,  minimum: 2, maximum: 20
     validates_length_of :last_name,   minimum: 2, maximum: 20         
     validates :email, format: { with: URI::MailTo::EMAIL_REGEXP }
     validates_uniqueness_of :email
     validates_length_of :password, minimum: 8
+
+    # A user account is considered spam/abandoned if:
+    # - The account has existed for at least N days
+    # - The account was never confirmed/activated
+    # - The the user never signed in to their account
+    #
+    # These records should be deleted from the database periodically
+    scope :spam, -> {
+      where("created_at <= ? AND sign_in_count <= 1 AND confirmed_at IS NULL", Time.zone.now - Polivalente::spam_account_ttl.days)
+    }
+
+    # A user account is inactive if:
+    # - The account has not been signed in to for more than X days
+    # These users should be notified about their account state
+    scope :inactive, -> {
+      where("current_sign_in_at <= ?", Time.zone.now - Polivalente::inactive_account_ttl.days)
+    }
+
+    scope :unconfirmed, -> { where(:confirmed_at => nil)}
+
+    def name
+      "#{first_name} #{last_name}"
+    end
   end
 end

data/app/serializers/polivalente/comment_serializer.rb

@@ -0,0 +1,8 @@
+module Polivalente
+  class CommentSerializer < ActiveModel::Serializer
+    attributes :id, :content
+    has_one :user
+    has_one :commentable
+    has_many :comments
+  end
+end

data/app/serializers/polivalente/reaction_serializer.rb

@@ -0,0 +1,7 @@
+module Polivalente
+  class ReactionSerializer < ActiveModel::Serializer
+    attributes :id, :kind
+    has_one :user
+    has_one :reactable
+  end
+end

data/app/serializers/polivalente/tag_serializer.rb

@@ -0,0 +1,6 @@
+module Polivalente
+  class TagSerializer < ActiveModel::Serializer
+    attributes :id, :name, :created_at
+    has_many :taggings
+  end
+end

data/app/serializers/polivalente/tagging_serializer.rb

@@ -0,0 +1,7 @@
+module Polivalente
+  class TaggingSerializer < ActiveModel::Serializer
+    attributes :id, :created_at
+    has_one :tag
+    has_one :taggable
+  end
+end

data/app/serializers/polivalente/user_serializer.rb

@@ -0,0 +1,9 @@
+module Polivalente
+  class UserSerializer < ActiveModel::Serializer
+    attributes :name, :photo_url
+
+    def photo_url
+      object.photo.url
+    end
+  end
+end

data/config/routes.rb

@@ -1,3 +1,11 @@
 Polivalente::Engine.routes.draw do
+  # Health check
+  resources :ping, only: [:index]
+
   devise_for :users, class_name: "Polivalente::User"
+
+  namespace :autocomplete, defaults: { format: :json } do
+    get 'tags',       as: :tag_completion
+    get 'users',      as: :user_completion
+  end
 end

data/db/migrate/20220124153504_create_users.rb

@@ -1,14 +1,13 @@
 class CreateUsers < ActiveRecord::Migration[7.0]
   def change
     create_table :users do |t|
-      t.string  :slug,         null: false,   unique: true
       t.string  :first_name,   null: false,   index: true
       t.string  :last_name,    null: false,   index: true
       t.boolean :is_admin,     null: false,   index: true, default: false
       t.boolean :is_verified,  null: false,   index: true, default: false
 
       ## Devise::DatabaseAuthenticatable
-      t.string :email,              null: false, default: "", unique: true
+      t.string :email,              null: false, default: "", index: { unique: true }
       t.string :encrypted_password, null: false, default: ""
 
       ## Devise::Recoverable

data/db/migrate/20220125040905_create_tags.rb

@@ -0,0 +1,9 @@
+class CreateTags < ActiveRecord::Migration[7.0]
+  def change
+    create_table :tags do |t|
+      t.string :name, null: false, index: { unique: true }
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20220125040916_create_taggings.rb

@@ -0,0 +1,12 @@
+class CreateTaggings < ActiveRecord::Migration[7.0]
+  def change
+    create_table :taggings do |t|
+      t.belongs_to :tag,      null: false, foreign_key: { on_delete: :cascade }
+      t.references :taggable, null: false, polymorphic: true, index: true
+
+      t.timestamps
+
+      t.index [:tag_id, :taggable_id, :taggable_type], unique: true, name: "index_unique_tagged_item"
+    end
+  end
+end

data/db/migrate/20220125040920_create_active_storage_tables.active_storage.rb

@@ -0,0 +1,36 @@
+# This migration comes from active_storage (originally 20170806125915)
+class CreateActiveStorageTables < ActiveRecord::Migration[5.2]
+  def change
+    create_table :active_storage_blobs do |t|
+      t.string   :key,          null: false
+      t.string   :filename,     null: false
+      t.string   :content_type
+      t.text     :metadata
+      t.string   :service_name, null: false
+      t.bigint   :byte_size,    null: false
+      t.string   :checksum,     null: false
+      t.datetime :created_at,   null: false
+
+      t.index [ :key ], unique: true
+    end
+
+    create_table :active_storage_attachments do |t|
+      t.string     :name,     null: false
+      t.references :record,   null: false, polymorphic: true, index: false
+      t.references :blob,     null: false
+
+      t.datetime :created_at, null: false
+
+      t.index [ :record_type, :record_id, :name, :blob_id ], name: "index_active_storage_attachments_uniqueness", unique: true
+      t.foreign_key :active_storage_blobs, column: :blob_id
+    end
+
+    create_table :active_storage_variant_records do |t|
+      t.belongs_to :blob, null: false, index: false
+      t.string :variation_digest, null: false
+
+      t.index %i[ blob_id variation_digest ], name: "index_active_storage_variant_records_uniqueness", unique: true
+      t.foreign_key :active_storage_blobs, column: :blob_id
+    end
+  end
+end

data/db/migrate/20220125040921_create_action_mailbox_tables.action_mailbox.rb

@@ -0,0 +1,14 @@
+# This migration comes from action_mailbox (originally 20180917164000)
+class CreateActionMailboxTables < ActiveRecord::Migration[6.0]
+  def change
+    create_table :action_mailbox_inbound_emails do |t|
+      t.integer :status, default: 0, null: false
+      t.string  :message_id, null: false
+      t.string  :message_checksum, null: false
+
+      t.timestamps
+
+      t.index [ :message_id, :message_checksum ], name: "index_action_mailbox_inbound_emails_uniqueness", unique: true
+    end
+  end
+end

data/db/migrate/20220125040922_create_action_text_tables.action_text.rb

@@ -0,0 +1,14 @@
+# This migration comes from action_text (originally 20180528164100)
+class CreateActionTextTables < ActiveRecord::Migration[6.0]
+  def change
+    create_table :action_text_rich_texts do |t|
+      t.string     :name, null: false
+      t.text       :body, size: :long
+      t.references :record, polymorphic: true, null: false, index: false
+
+      t.timestamps
+
+      t.index [ :record_type, :record_id, :name ], name: "index_action_text_rich_texts_uniqueness", unique: true
+    end
+  end
+end

data/db/migrate/20220125044901_create_comments.rb

@@ -0,0 +1,13 @@
+class CreateComments < ActiveRecord::Migration[7.0]
+  def change
+    create_table :comments do |t|
+      t.belongs_to :user,         null: false, index: true, foreign_key: { on_delete: :cascade }
+      t.references :commentable,  null: false, index: true, polymorphic: true
+      t.string     :content_hash, null: false
+      t.boolean    :is_private,   null: false, default: false
+      t.datetime   :discarded_at, null: true,  index: true
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20220125144339_create_reactions.rb

@@ -0,0 +1,14 @@
+class CreateReactions < ActiveRecord::Migration[7.0]
+  def change
+    create_table :reactions do |t|
+      t.belongs_to :user,      null: false, index: true, foreign_key: { on_delete: :cascade }
+      t.references :reactable, null: false, polymorphic: true
+      t.integer    :kind,      null: false, index: true, limit: 20
+      t.json       :data,      null: true,  default: "{}"
+
+      t.timestamps
+
+      t.index [:user_id, :kind, :reactable_type, :reactable_id], unique: true, name: "index_unique_user_reactions"
+    end
+  end
+end

data/db/migrate/20220125144342_create_trash.rb

@@ -0,0 +1,12 @@
+class CreateTrash < ActiveRecord::Migration[6.1]
+  def change
+    create_table :trash do |t|
+      t.belongs_to :user,      null: false, foreign_key: { on_delete: :cascade }
+      t.references :trashable, null: false, polymorphic: true, index: true
+
+      t.timestamps
+
+      t.index [:user_id, :trashable_id, :trashable_type], unique: true, name: "index_unique_trash_item"
+    end
+  end
+end

data/db/migrate/20220130033524_create_archives.rb

@@ -0,0 +1,12 @@
+class CreateArchives < ActiveRecord::Migration[7.0]
+  def change
+    create_table :archives do |t|
+      t.belongs_to :user,       null: false, foreign_key: { on_delete: :cascade }
+      t.references :archivable, null: false, polymorphic: true, index: true
+
+      t.timestamps
+
+      t.index [:user_id, :archivable_id, :archivable_type], unique: true, name: "index_unique_archive_item"
+    end
+  end
+end

data/lib/generators/polivalente/install/install_generator.rb

@@ -0,0 +1,9 @@
+module Polivalente
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      def copy_migrations
+        rails_command "railties:install:migrations FROM=polivalente", inline: true
+      end
+    end
+  end
+end

data/lib/generators/rails/concern/USAGE

@@ -0,0 +1,10 @@
+Description:
+    Stubs out a model concern.
+
+    This generator accepts one argument, the name of the concern, CamelCased or under_scored.
+
+Example:
+    rails generate concern Thing 
+
+    This will create:
+        apps/models/concerns/thing.rb

data/lib/generators/rails/concern/concern_generator.rb

@@ -0,0 +1,7 @@
+class ConcernGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path('templates', __dir__)
+
+  def create_concern
+    template("concern.rb", File.join("app/models/concerns/#{class_name.underscore}.rb"))
+  end
+end

data/lib/generators/rails/concern/templates/concern.rb

@@ -0,0 +1,6 @@
+module <%= class_name %>
+  extend ActiveSupport::Concern
+
+  included do
+  end
+end

data/lib/generators/rails/stimulus/USAGE

@@ -0,0 +1,9 @@
+Description:
+    Stubs out a new Stimulus controller.
+
+    This generator accepts one argument, the name of the controller, CamelCased or under_scored.
+
+Example:
+    `rails generate stimulus Thing`
+
+    This will create a new Stimulus controller at `app/javascript/controllers/thing_controller.js`

data/lib/generators/rails/stimulus/stimulus_generator.rb

@@ -0,0 +1,14 @@
+class StimulusGenerator < Rails::Generators::NamedBase
+  # Source: https://github.com/DavidColby/rails-stimulus-generator
+  source_root File.expand_path('templates', __dir__)
+
+  check_class_collision suffix: "Controller"
+
+  def create_controller_directory
+    empty_directory("app/javascript/controllers") unless File.directory?("app/javascript/controllers")
+  end
+
+  def create_controller
+    template("controller.js", File.join("app/javascript/controllers/#{file_name}_controller.js"))
+  end
+end

data/lib/generators/rails/stimulus/templates/controller.js

@@ -0,0 +1,17 @@
+import { Controller } from 'stimulus'
+
+export default class extends Controller {
+  static targets = []
+
+  initialize() {
+    // Called once, when the controller is first instantiated
+  }
+
+  connect() {
+    // Called any time the controller is connected to the DOM
+  }
+
+  disconnect() {
+    // Called any time the controller is disconnected from the DOM
+  }
+}

data/lib/generators/rails/validator/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Stubs out a validator.
+
+Example:
+    rails generate validator Thing
+
+    This will create:
+        apps/validator/thing_validator.rb

data/lib/generators/rails/validator/templates/validator.rb

@@ -0,0 +1,5 @@
+class <%= class_name %>Validator < ActiveModel::EachValidator
+  def validate_each(record, attribute, value)
+    # validator code...
+  end
+end

data/lib/generators/rails/validator/validator_generator.rb

@@ -0,0 +1,7 @@
+class ValidatorGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path('templates', __dir__)
+
+  def create_concern
+    template("validator.rb", File.join("app/validators/#{class_name.underscore}_validator.rb"))
+  end
+end

data/lib/polivalente/engine.rb

@@ -1,5 +1,21 @@
 module Polivalente
   class Engine < ::Rails::Engine
     isolate_namespace Polivalente
+
+    config.generators do |g|
+      g.scaffold_stylesheet  false
+      g.assets               false
+      g.test_framework       :rspec
+      g.fixture_replacement  :factory_bot
+      g.factory_bot dir:     "spec/factories"
+    end
+
+    initializer "polivalente.factories", after: "factory_bot.set_factory_paths" do
+      FactoryBot.definition_file_paths << File.expand_path('../../../spec/factories', __FILE__) if defined?(FactoryBot)
+    end
+  end
+
+  # Do not prefix table names with `polivantente_`
+  def self.table_name_prefix
   end
 end

data/lib/polivalente/user_locale.rb

@@ -0,0 +1,24 @@
+module Polivalente
+  module UserLocale
+
+    protected
+
+    def set_user_locale!
+      @user_locale ||= params[:locale] ||
+        session[:locale] ||
+        extracted_locale_from_header ||
+        I18n.default_locale
+
+      I18n.locale = @user_locale
+
+    rescue I18n::InvalidLocale
+      I18n.locale = @user_locale = I18n.default_locale
+    end
+
+    def extracted_locale_from_header
+      request.headers['HTTP_ACCEPT_LANGUAGE'].scan(/^[a-z]/).first.to_sym
+    rescue NoMethodError
+      nil
+    end
+  end
+end

data/lib/polivalente/version.rb

@@ -1,3 +1,3 @@
 module Polivalente
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/lib/polivalente.rb

@@ -1,15 +1,33 @@
 require "polivalente/version"
 require "polivalente/railtie"
 require "polivalente/engine"
+
+# Third-party
+
+require "active_model_serializers"
 require "devise"
+require "discard"
+require "factory_bot_rails"
 
 module Polivalente
   # Attributes
+  mattr_accessor :inactive_account_ttl
+  mattr_accessor :spam_account_ttl
+  mattr_accessor :supported_locales
+  mattr_accessor :trash_ttl
+
+  self.inactive_account_ttl = 60.days
+  self.spam_account_ttl     = 4.days
+  self.supported_locales    = [:en]
+  self.trash_ttl            = 30.days
+
+  # Modules
+  autoload :UserLocale,    "polivalente/user_locale"
 
   # Configuration
 
+  # do not prefix table names with `polivantente_`
   def self.table_name_prefix
-    # do not prefix table names with `polivantente_`
   end
 
   def self.setup

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: polivalente
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Leo Neto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-25 00:00:00.000000000 Z
+date: 2022-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -30,6 +30,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: active_model_serializers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: devise
   requirement: !ruby/object:Gem::Requirement
@@ -44,6 +58,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.8'
+- !ruby/object:Gem::Dependency
+  name: discard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: factory_bot_rails
   requirement: !ruby/object:Gem::Requirement
@@ -58,6 +86,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '6.2'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.19'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.19'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -83,21 +125,73 @@ files:
 - README.md
 - Rakefile
 - app/assets/config/polivalente_manifest.js
+- app/assets/images/polivalente/user-sample.jpg
 - app/assets/stylesheets/polivalente/application.css
 - app/controllers/polivalente/application_controller.rb
+- app/controllers/polivalente/autocomplete_controller.rb
+- app/controllers/polivalente/ping_controller.rb
 - app/helpers/polivalente/application_helper.rb
+- app/helpers/polivalente/color_helper.rb
+- app/helpers/polivalente/enum_helper.rb
+- app/helpers/polivalente/gravatar_helper.rb
+- app/helpers/polivalente/tags_helper.rb
 - app/jobs/polivalente/application_job.rb
+- app/jobs/polivalente/clean_trash_job.rb
 - app/mailers/polivalente/application_mailer.rb
+- app/models/concerns/polivalente/archivable.rb
+- app/models/concerns/polivalente/archiver.rb
+- app/models/concerns/polivalente/commentable.rb
+- app/models/concerns/polivalente/commentator.rb
+- app/models/concerns/polivalente/content_hashable.rb
+- app/models/concerns/polivalente/reactable.rb
+- app/models/concerns/polivalente/reactor.rb
+- app/models/concerns/polivalente/sortable.rb
+- app/models/concerns/polivalente/taggable.rb
+- app/models/concerns/polivalente/trashable.rb
+- app/models/concerns/polivalente/trasher.rb
+- app/models/concerns/polivalente/user_owned.rb
+- app/models/concerns/polivalente/visibility.rb
 - app/models/polivalente/application_record.rb
+- app/models/polivalente/archive.rb
+- app/models/polivalente/comment.rb
+- app/models/polivalente/reaction.rb
+- app/models/polivalente/tag.rb
+- app/models/polivalente/tagging.rb
+- app/models/polivalente/trash.rb
 - app/models/polivalente/user.rb
+- app/serializers/polivalente/comment_serializer.rb
+- app/serializers/polivalente/reaction_serializer.rb
+- app/serializers/polivalente/tag_serializer.rb
+- app/serializers/polivalente/tagging_serializer.rb
+- app/serializers/polivalente/user_serializer.rb
 - app/views/layouts/polivalente/application.html.erb
 - config/initializers/devise.rb
 - config/locales/devise.en.yml
 - config/routes.rb
 - db/migrate/20220124153504_create_users.rb
+- db/migrate/20220125040905_create_tags.rb
+- db/migrate/20220125040916_create_taggings.rb
+- db/migrate/20220125040920_create_active_storage_tables.active_storage.rb
+- db/migrate/20220125040921_create_action_mailbox_tables.action_mailbox.rb
+- db/migrate/20220125040922_create_action_text_tables.action_text.rb
+- db/migrate/20220125044901_create_comments.rb
+- db/migrate/20220125144339_create_reactions.rb
+- db/migrate/20220125144342_create_trash.rb
+- db/migrate/20220130033524_create_archives.rb
+- lib/generators/polivalente/install/install_generator.rb
+- lib/generators/rails/concern/USAGE
+- lib/generators/rails/concern/concern_generator.rb
+- lib/generators/rails/concern/templates/concern.rb
+- lib/generators/rails/stimulus/USAGE
+- lib/generators/rails/stimulus/stimulus_generator.rb
+- lib/generators/rails/stimulus/templates/controller.js
+- lib/generators/rails/validator/USAGE
+- lib/generators/rails/validator/templates/validator.rb
+- lib/generators/rails/validator/validator_generator.rb
 - lib/polivalente.rb
 - lib/polivalente/engine.rb
 - lib/polivalente/railtie.rb
+- lib/polivalente/user_locale.rb
 - lib/polivalente/version.rb
 - lib/tasks/polivalente_tasks.rake
 homepage: https://github.com/oleoneto/polivalente