polivalente 0.1.0 → 0.3.1

data/lib/generators/polivalente/templates/polivalente.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+Polivalente.configure do |config|
+  # ==> User configuration
+  config.user_class = "::User"
+
+  # ==> Controller configuration
+  config.base_controller     = "::ApplicationController"
+  config.base_api_controller = "::ApplicationController"
+
+  # ==> Account configuration
+  config.inactive_account_ttl = 60.days
+  config.spam_account_ttl     = 4.days
+
+  # ==> Locales configuration
+  config.supported_locales    = [:en]
+
+  # ==> Trash configuration
+  config.trash_ttl            = 30.days
+end

data/lib/generators/polivalente/templates/user.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+class User < ApplicationRecord
+  include Polivalente::Archiver
+  include Polivalente::Commentator
+  include Polivalente::Reactor
+  include Polivalente::Sortable
+  include Polivalente::Trasher
+
+  # Include default devise modules. Others available are:
+  # :registerable, :validatable,
+  # :timeoutable, and :omniauthable
+
+  devise :database_authenticatable,
+         :confirmable,
+         :rememberable,
+         :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 - spam_account_ttl)
+  }
+
+  # 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 - inactive_account_ttl)
+  }
+
+  scope :unconfirmed, -> { where(:confirmed_at => nil)}
+
+  def name
+    "#{first_name} #{last_name}"
+  end
+
+  module ClassMethods
+    def inactive_account_ttl
+      Polivalente.config.inactive_account_ttl.days
+    end
+
+    def spam_account_ttl
+      Polivalente.config.spam_account_ttl.days
+    end
+  end
+end

data/lib/generators/polivalente/user/user_generator.rb

@@ -0,0 +1,11 @@
+module Polivalente
+  module Generators
+    class UserGenerator < ::Rails::Generators::Base
+      source_root File.expand_path("../../templates", __FILE__)
+
+      def copy_user_model
+        template "user.rb", "app/models/user.rb"
+      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/configuration.rb

@@ -0,0 +1,11 @@
+module Polivalente
+  class Configuration
+    attr_accessor  :base_controller
+    attr_accessor  :base_api_controller
+    attr_accessor  :inactive_account_ttl
+    attr_accessor  :spam_account_ttl
+    attr_accessor  :supported_locales
+    attr_accessor  :trash_ttl
+    attr_accessor  :user_class
+  end
+end

data/lib/polivalente/engine.rb

@@ -1,5 +1,24 @@
 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
+
+    # Loads engine helpers in main application
+    initializer "local_helper.action_controller" do
+      ActiveSupport.on_load :action_controller do
+        helper Polivalente::Engine.helpers
+      end
+    end
+
+    # Do not prefix table names with `polivantente_`
+    def self.table_name_prefix
+    end
   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.0"
+  VERSION = "0.3.1"
 end

data/lib/polivalente.rb

@@ -1,18 +1,31 @@
 require "polivalente/version"
 require "polivalente/railtie"
 require "polivalente/engine"
+require "polivalente/configuration"
+
+# Third-party
+
+require "active_model_serializers"
 require "devise"
+require "discard"
 
 module Polivalente
-  # Attributes
+  class << self
+    attr_reader :config
+
+    def configure
+      @config = Configuration.new
+      yield config
+    end
+  end
+  
+
+  # 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
-    yield self
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: polivalente
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Leo Neto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-25 00:00:00.000000000 Z
+date: 2022-02-09 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
@@ -72,7 +114,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
-description: Reusable generic features extracted out of our Rails apps
+description: Reusable generic features for Rails applications
 email:
 - leo@ekletik.com
 executables: []
@@ -83,21 +125,81 @@ 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/user.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/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/locales/en.yml
+- config/locales/es.yml
+- config/locales/fr.yml
+- config/locales/pt.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/polivalente/templates/README
+- lib/generators/polivalente/templates/active_model_serializers.rb
+- lib/generators/polivalente/templates/polivalente.rb
+- lib/generators/polivalente/templates/user.rb
+- lib/generators/polivalente/user/user_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/configuration.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
@@ -106,7 +208,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/oleoneto/polivalente
   source_code_uri: https://github.com/oleoneto/polivalente
-  changelog_uri: https://github.com/oleoneto/polivalente/blob/master/CHANGELOG.md
+  changelog_uri: https://github.com/oleoneto/polivalente/blob/main/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:

data/app/models/polivalente/user.rb

@@ -1,20 +0,0 @@
-module Polivalente
-  class User < ApplicationRecord
-    # Include default devise modules. Others available are:
-    # :registerable, :validatable,
-    # :timeoutable, and :omniauthable
-  
-    devise :database_authenticatable,
-           :confirmable,
-           :rememberable,
-           :recoverable,
-           :lockable,
-           :trackable
-
-    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
-  end
-end