sequenced_mailer 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f10a1518274cbebdac21ddee3a8fe759b53bba5f65601991025bad9822d53ca6
-  data.tar.gz: 2675de6f53963f9cd1ce5fc8e9f0e6e97811a6b7ec5d170f2a8cf5f225c92ce5
+  metadata.gz: b6075f7b3859cbdc368cc29e479e71e88cf305677edd0cd1216992e1485de7e0
+  data.tar.gz: e6c0388cf8a66da75a8360d035a92a2c15142fa5b44f08f1045c766fc5ae94ed
 SHA512:
-  metadata.gz: a8071455c749d4facad14150af141f65ed425c6743b20aad4ca257cd47a837db8727e434400d8f0ddeb4e2f588f1e27e43917a2a9abd79afd192c7303df5e8d9
-  data.tar.gz: 2e41f703928a33497433ebb6b942a03077c05bf1bf8bcd8b93775252cdd325bfd303362e85df9edd50a4d9469daa4ec597426e8ac1be1f4bd4f0c6b793a9fb14
+  metadata.gz: f64c966850c580123f675825dcab14610a70c2853237127a7a9dd234ca42342be923542bf9f07e18efe3b4a2d54bc4980c05a7804e091bcd7bbdf4a218637c6e
+  data.tar.gz: dc585a8b953adb9bafec2d1158e6d177313cea4214b69b237693c72d12ef9e8fa87839e917b980159f1d23b656c0a0702237d927c59bac43f5c4703ce2c9e35a

data/.rubocop.yml

@@ -0,0 +1,70 @@
+require:
+  - standard
+  - rubocop-rails
+  - rubocop-rspec
+  - rubocop-performance
+  - rubocop-capybara
+  - rubocop-factory_bot
+
+inherit_gem:
+  standard: config/base.yml
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 3.2
+  Exclude:
+    - node_modules/**/*
+    - public/**/*
+    - vendor/**/*
+    - db/**/*
+    - bin/**/*
+
+Rails:
+  Enabled: true # enable rubocop-rails cops
+Rails/OutputSafety:
+  Enabled: false
+Rails/I18nLocaleTexts:
+ Enabled: false
+Rails/Output:
+  Enabled: false
+Style/RedundantRegexpEscape:
+  Enabled: false
+Rails/UnknownEnv:
+  Environments:
+    - production
+    - development
+    - test
+    - staging
+
+RSpec:
+  Enabled: true # enable rubocop-rspec cops
+RSpec/DescribeClass:
+  Enabled: false # ignore missing comments on classes
+RSpec/ExampleLength:
+  Enabled: false
+RSpec/MultipleExpectations:
+  Enabled: false
+RSpec/Focus:
+  Enabled: false
+RSpec/FilePath:
+  IgnoreMethods: true
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false
+RSpec/NestedGroups:
+  Enabled: false
+Rails/RakeEnvironment:
+  Enabled: false
+Rails/ApplicationRecord:
+  Enabled: false
+Rails/FindEach:
+  Enabled: false
+RSpec/AnyInstance:
+  Enabled: false
+RSpec/MessageSpies:
+  Enabled: false
+RSpec/ImplicitSubject:
+  Enabled: false
+Rails/HelperInstanceVariable:
+  Enabled: false
+RSpec/IndexedLet:
+  Enabled: false

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## [Unreleased]
 
+## [0.2.0] - 2023-07-05
+
+- Add a description to sequence owner
+
+
 ## [0.1.0] - 2023-06-20
 
 - Initial release

data/app/concerns/mailing/sequenceable.rb

@@ -7,7 +7,7 @@ module Mailing::Sequenceable
     def add_to_sequence(name)
       logger.debug { "Will try to add to sequence: #{name}" }
       sequence = Mailing::Sequence.find_by(name: name)
-      return unless sequence.present?
+      return if sequence.blank?
 
       if sequence_owners.where(mailing_sequence_id: sequence.id, canceled_at: nil).any?
         logger.debug { "User is already in the sequence" }
@@ -18,7 +18,7 @@ module Mailing::Sequenceable
     end
 
     def cancel_sequence(name)
-      sequence_owner = sequence_owners.joins(:sequence).where(sequence: { name: name }).first
+      sequence_owner = sequence_owners.joins(:sequence).where(sequence: {name: name}).first
       return if sequence_owner.blank?
 
       sequence_owner.cancel!

data/app/models/mailing/sequence.rb

@@ -1,8 +1,10 @@
 class Mailing::Sequence < ActiveRecord::Base
   validates :name, presence: true, uniqueness: true
 
-  has_many :sequence_owners, class_name: "Mailing::SequenceOwner", dependent: :destroy, inverse_of: :sequence, foreign_key: "mailing_sequence_id"
-  has_many :steps, class_name: "Mailing::SequenceStep", dependent: :destroy, foreign_key: :mailing_sequence_id, inverse_of: :sequence
+  has_many :sequence_owners, class_name: "Mailing::SequenceOwner", dependent: :destroy, inverse_of: :sequence,
+    foreign_key: "mailing_sequence_id"
+  has_many :steps, class_name: "Mailing::SequenceStep", dependent: :destroy, foreign_key: :mailing_sequence_id,
+    inverse_of: :sequence
   has_many :owners, through: :sequence_owners, source_type: "User"
 
   def self.name_and_steps_count
@@ -13,29 +15,12 @@ class Mailing::Sequence < ActiveRecord::Base
   def self.send_mails(dry_run: false)
     name_and_steps_count.each do |name, steps_count|
       logger.debug { "Sending mails for #{name} (#{steps_count} steps)" }
-      Mailing::SequenceOwner.joins(:sequence).where(sequence: {name: name}).where("current_step < ? ", steps_count).where(canceled_at: nil).each do |owner|
-        logger.debug { "\tVerify to send mail to #{owner.owner_name} current_step is #{owner.current_step}" }
+      Mailing::SequenceOwner.joins(:sequence).where(sequence: {name: name})
+        .where("current_step < ? ", steps_count)
+        .where(canceled_at: nil).each do |owner|
+        logger.debug { "\tIf ready, will send mail to #{owner.owner_name} current_step is #{owner.current_step}" }
         owner.send_next_step_if_ready(dry_run: dry_run)
       end
     end
   end
-
-  def self.sequences_and_steps_names
-    {"onboarding_admin_sigilium" => {user_promoted: 0},
-     "onboarding_sigilium" => {welcome: 1},
-     "subscription_failed_payment" => {first_alert: 1}}
-  end
-
-  def self.seed
-    sequences_and_steps_names.each do |sequence_name, steps_details|
-      sequence = Mailing::Sequence.find_or_create_by(name: sequence_name)
-      steps_details.each.with_index do |step_details, index|
-        step_name, days_after_last_step = step_details
-        step = sequence.steps.find_or_initialize_by(name: step_name)
-        step.days_after_last_step = days_after_last_step
-        step.position = index + 1
-        step.save!
-      end
-    end
-  end
 end

data/app/models/mailing/sequence_owner.rb

@@ -4,20 +4,28 @@ class Mailing::SequenceOwner < ActiveRecord::Base
   delegate :steps, to: :sequence
   after_create :send_next_step_if_ready
 
-  delegate :name, to: :next_step, prefix: true
+  delegate :name, :ready_at, to: :next_step, prefix: true
   delegate :name, to: :owner, prefix: true
   delegate :name, to: :sequence, prefix: true
 
   def owner_name
-    if owner.respond_to?(:full_name)
-      owner.full_name
+    if owner.respond_to?(:mailing_sequence_owner_description)
+      owner.mailing_sequence_owner_description
     else
       owner.name
     end
   end
 
   def description
-    ["Sequence: #{sequence_name}", "Owner: #{owner_name}", "Step: #{next_step_name}"].join(" - ")
+    desc = ["Sequence: #{sequence_name}", "Owner: #{owner_name}"]
+    desc << "Canceled at: #{canceled_at}" if canceled?
+    desc << if last_step?
+      "Finished"
+    else
+      "Next Step : #{next_step_name}, ready to send at: #{I18n.l(next_step_ready_at)}"
+    end
+
+    desc.join(" - ")
   end
 
   def cancel!
@@ -47,6 +55,10 @@ class Mailing::SequenceOwner < ActiveRecord::Base
     next_step.ready_to_send?(last_activity_at)
   end
 
+  def next_step_ready_at
+    next_step.ready_at(last_activity_at)
+  end
+
   def last_step?
     next_step.blank?
   end

data/app/models/mailing/sequence_step.rb

@@ -6,6 +6,10 @@ class Mailing::SequenceStep < ActiveRecord::Base
     last_activity_at.beginning_of_day + days_after_last_step.days <= Time.zone.now
   end
 
+  def ready_at(last_activity_at)
+    (last_activity_at.beginning_of_day + days_after_last_step.days).to_date
+  end
+
   def send_to_owner(sequence_owner)
     # on a un scheduler qui appel les mails à envoyer les jours ouvrés
     #

data/lib/generators/sequenced_mailer/utils.rb

@@ -15,8 +15,8 @@ module SequencedMailer
         end
 
         def ask_boolean(wording, _default_value = nil)
-          value = ask_for(wording, 'Y')
-          value = (value == 'Y')
+          value = ask_for(wording, "Y")
+          (value == "Y")
         end
       end
     end

data/lib/sequenced_mailer/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SequencedMailer
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sequenced_mailer
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Thomas Darde
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-01 00:00:00.000000000 Z
+date: 2023-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -88,6 +88,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".rspec"
+- ".rubocop.yml"
 - ".standard.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
@@ -130,7 +131,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.14
+rubygems_version: 3.4.15
 signing_key:
 specification_version: 4
 summary: Send emails in sequence.