pfa 1.0.1

data/lib/assets/fr/PFA_ABSOLUTE_DATA.yaml

@@ -0,0 +1,212 @@
+---
+# Données absolues du PFA (FPA Absolute Data)
+
+times:
+  zero:
+    description:  Temps zéro pris en référence pour rectifier toutes les valeurs.
+    type:         time
+    printed:      false
+    required:     true
+
+  end_time:
+    description:  Temps de fin du film (en général au début du générique de fin)
+    type:         time
+    printed:      false
+    required:     true
+
+# Exemple des temps pour un film de 120 minutes
+# 1/4   = 30 minutes
+# 1/24  = 5 minutes
+nodes:
+  # --- EXPOSITION ---
+  exposition:
+    printed:      true
+    required:     true
+    id:           'EX'
+    hname:        'EXPOSITION'
+    type:         part
+    abs_start:    0
+    abs_duration: 1/4 # p.e. 30 minutes
+    items:        ['prelude', 'incident_perturbateur', 'incident_declencheur', 'zone_de_refus', 'pivot1']
+  preambule:
+    printed:      true
+    drawn:        false # pas sur le PFA
+    required:     false
+    type:         sequence
+    id:           "PR"
+    hname:        "Préambule"
+    description:  "Introduction du film, souvent la présentation du personnage et de son contexte de vie."
+    abs_start:    0
+    abs_duration: 1/24 # p.e. 5 mn => fin à 5 mn
+  incident_perturbateur:
+    printed:      true
+    drawn:        true # sur le PFA
+    required:     false
+    type:         noeud
+    id:           "IP"
+    hname:        "Incident perturbateur"
+    abs_start:    1/24 # p.e. 5 mn
+    abs_duration: 1/24 # p.e. 5 mn => fin à 10 mn
+  incident_declencheur:
+    printed:      true
+    drawn:        true # sur le PFA
+    required:     true
+    type:         noeud
+    id:           "ID"
+    hname:        "Incident déclencheur"
+    description:  "Moment qui déclenche l'histoire, qui permet de définir l'objectif ou la QDF (Question Dramatique Fondamentale)."
+    abs_start:    2/24 # p.e. 10 mn
+    abs_duration: 1/24 # p.e. 5 mn => fin à 15 mn
+  zone_de_refus:
+    printed:      true
+    drawn:        false # pas sur le PFA
+    required:     false
+    type:         sequence
+    id:           "ZR"
+    hname:        "Zone de refus"
+    description:  "Moment de l'histoire où le personnage refuse son objectif (directement ou indirectement, consciemment ou inconsciemment)."
+    abs_start:    3/24 # p.e. 15 mn
+    abs_duration: 2/24 # p.e. 10 mn => fin à 25 mn
+  pivot1:
+    printed:      true
+    drawn:        true # sur le PFA
+    required:     true
+    type:         noeud
+    id:           "P1"
+    hname:        "Premier pivot"
+    abs_start:    1/4 - 1/24 # p.e. 30 mn - 5 mn = 25 mn
+    abs_duration: 1/24 # p.e. 5 mn => fin à 30 mn
+    description:  "Moment de l'histoire où le personnage accepte son objectif, ce qui fait basculer le récit dans le développement."
+
+  # --- DÉVELOPPEMENT PARTIE 1 ---
+  developpement_part1:
+    printed:      true
+    drawn:        true # sur le PFA
+    type:         part
+    id:           'D1'
+    hname:        'DÉV. PART I'
+    abs_start:    1/4
+    abs_duration: 1/4
+    items: ['premiere_action', 'premier_tiers', 'cle_de_voute']
+  action_1_part1:
+    printed:      false
+    drawn:        false # pas sur le PFA
+    required:     false
+    type:         noeud
+    id:           "A1"
+    hname:        "Première action"
+    description:  "La toute première action entreprise par le protagoniste pour atteindre son objectif."
+    abs_start:    1/4
+    abs_duration: null
+  premier_tiers:
+    printed:      true
+    drawn:        true # sur le PFA
+    required:     false
+    type:         noeud
+    id:           "T1"
+    hname:        "Premier tiers"
+    description:  "Souvent, à un tiers du film, il se passe quelque chose qui résonnera avec le 2 tiers, et/ou qui découpage le film en trois parties."
+    abs_start:    1/3
+    abs_duration: null
+  cle_de_voute:
+    printed:      true
+    drawn:        true # sur le PFA
+    required:     false
+    type:         noeud
+    id:           'CV'
+    hname:        "Clé de voûte" # insécable pour ne pas être coupé là à l'affichage dans le graphique
+    description:  "Scène faisant basculer l'histoire vers un autre pan, découpant le film en deux parties distinctes."
+    abs_start:    1/2 - 1/48 # p.e. 60 mn - 2,5 mn 
+    abs_duration: 1/24 # p.e. 5 mn
+
+  # --- DÉVELOPPEMENT PARTIE 2 ---
+  developpement_part2:
+    printed:      true
+    drawn:        true # sur le PFA
+    type:         part
+    id:           'D2'
+    hname:        'DÉV. PART II'
+    abs_start:    1/2
+    abs_duration: 1/4
+    items:        ['premiere_action_dev2', 'deuxieme_tiers', 'crise', 'pivot2']
+  action_1_part2:
+    printed:      false
+    drawn:        false # pas sur le PFA
+    required:     false
+    type:         noeud
+    id:           "A2"
+    hname:        "Première action de 2e partie"
+    description:  "Pendant de la première action du développement, après la clé de voûte."
+    abs_start:    1/2 + 1/48 # p.e. 60 + 2,5 mn = 62,5 mn
+    abs_duration: null
+  deuxieme_tiers:
+    printed:      true
+    drawn:        true # sur le PFA
+    required:     false
+    type:         noeud
+    id:           "T2"
+    hname:        "Deuxième tiers"
+    description:  "Deuxième temps de la découpe du film en 3 parties et/ou scène en résonance avec la scène à 1/3."
+    abs_start:    2/3
+    abs_duration: null
+  crise:
+    printed:      true
+    drawn:        true # sur le PFA
+    required:     false
+    type:         noeud
+    id:           "CR"
+    hname:        "Crise"
+    description:  "Moment du film où tout semble définitivement perdu pour le protagoniste. Il ne semble ne plus jamais pouvoir atteindre son objectif."
+    abs_start:    3/4 - 2/24 # p.e. 90 mn - 10 mn = 80 mn
+    abs_duration: 1/24
+  pivot2:
+    printed:      true
+    drawn:        true # sur le PFA
+    required:     true
+    type:         noeud
+    id:           "P2"
+    hname:        "Second Pivot"
+    description:  "Moment de l'histoire qui la fait basculer dans le dénouement (souvent la sortie de crise)."
+    abs_start:    3/4 - 1/24
+    abs_duration: 1/24
+
+  # --- DÉNOUEMENT ---
+  denouement:
+    printed:      true
+    drawn:        true # sur le PFA
+    type:         part
+    id:           'DE' # IMPÉRATIF
+    hname:        'DÉNOUEMENT'
+    abs_start:    3/4
+    abs_duration: 1/4
+    items:        ['premiere_action_den', 'climax', 'desinence']
+  action_1_denouement:
+    printed:      false
+    drawn:        false # pas sur le PFA
+    required:     false
+    type:         noeud
+    id:           "A3"
+    hname:        "Première action de dénouement"
+    description:  "Première action entrepris par le protagoniste, volontairement ou involontairement, pour se rendre au climax."
+    abs_start:    3/4
+    abs_duration: null
+  climax:
+    printed:      true
+    drawn:        true # sur le PFA
+    required:     true
+    type:         noeud
+    id:           "CX"
+    hname:        "Climax"
+    description:  "Scène d'opposition frontale entre le protagoniste et les forces antagonistes. Donne ou permet de donnée la RDF (Réponse Dramatique Fondamentale)."
+    abs_start:    1 - 3/24 # p.e. 120 mn - 15 mn = 105 mn
+    abs_duration: 2/24 # p.e. 10 mn => fin à 115 mn
+  desinence:
+    printed:      true
+    drawn:        false # pas sur le PFA
+    required:     false
+    type:         sequence
+    id:           "DS"
+    hname:        "Désinence"
+    description:  "Terminaison extrême du film, après que le climax a été joué."
+    abs_start:    1 - 1/24 # p.e. 120 mn - 5 mn = 115 mn
+    abs_duration: 1/24 # p.e. 5mn

data/lib/assets/fr/errors.yaml

@@ -0,0 +1,107 @@
+---
+# Pour générer une de ces erreurs, utiliser :
+#   raise PFAFatalError.new(<code>[, <{template valeurs}>])
+
+# --- Méthodes générales
+
+50: >
+  La valeur %{value} devrait être un Time…
+51: >
+  La valeur %{value} devrait être un nombre de secondes…
+52: > # valeur incorrecte pour estimer un temps
+  La valeur de temps %{value} est incorrecte.
+  Les formats pour les temps valides sont :
+    - un nombre de secondes      126
+    - un Time                     Time.at(3600+56)
+    - une horloge "virgule"       "1,46,12"
+    - une horloge "plus"          "1+46+12"
+    - une horloge normale         "0:12:45"
+53: > # valeur incorrecte pour initialiser un NTime
+  La valeur %{value} est incorrecte pour initialiser un \PFA::NTime
+  Il faut fournir au choix :
+    - un nombre de secondes ([Integer|Float])
+    - un temps ([Time])
+    - une horloge valide ([String])
+    - une instance NTime ([PFA::NTime])
+  La valeur fournie est de classe %{classe}.
+
+
+# --- Les données du PFA ---
+100: >
+  La clé %{key} est inconnue des données du PFA…
+101: |
+  Il faut définir les dimensions à utiliser en appelant la méthode
+  build avec une table contenant au moins :as dont la valeur est
+  une des valeurs contenues dans la constante DIMS_CONSTANTS_PER_THING
+  du fichier any_builder.rb ou une table définissant les valeurs
+  :pfa_width, :pfa_height, :pfa_left_margin et :pfa_right_margin
+
+  Par exemple : 
+
+      pfa.build(**{as: real_book})
+
+200: >
+  Le zéro doit être défini.
+
+  Utiliser pfa.add(:zero, 'H+M+S')
+201: >
+  Le temps réel de fin doit être défini.
+  
+  Utiliser pfa.add(:end_time, 'H+M+S')
+202: >
+  L'incident déclencheur doit être défini.
+  
+  Utiliser pfa.add(:incident_declencheur, {t:'h,m,s', d:"<description>"[, duree: <secondes>]})
+203: >
+  Le premier pivot doit être défini.
+  
+  Utiliser pfa.add(:pivot1, {t:'h,m,s', d:"<description>"[, duree: <secondes>]})
+204: >
+  La première partie de développement doit être définie.
+  
+  Utiliser pfa.add(:developpement_part1, {t:'h,m,s', d:"<description>"})
+205: >
+  Le second pivot doit être défini.
+  
+  Utiliser pfa.add(:pivot2, {t:'h,m,s', d:"<description>"[, duree: <secondes>]})
+206: >
+  Le dénouement doit être défini.
+  
+  Utiliser pfa.add(:denouement, {t:'h,m,s', d:"<description>"})
+207: >
+  Le climax doit être défini.
+  
+  Utiliser pfa.add(:climax, {t:'h,m,s', d:"<description>"[, duree: <secondes>]})
+208: >
+  La seconde moitié de développement doit être définie.
+  
+  Utiliser pfa.add(:developpement_part2, {t:'h,m,s', d:"<description>"})
+209: >
+  L'exposition du film doit être définie.
+
+  Utiliser pfa.add(:exposition, {t:'<horloge>', d:'<description>'})
+
+219: >
+  La propriété :%{key} est mal définie. Ça devrait être une table
+  contenant au minimum :t (ou :time) et :d (ou :description). Or,
+  c'est une instance de type %{classe}.
+220: >
+  Les temps sont mal réglés.
+  Le temps de :%{key_before} (%{h_before}) devrait être avant le temps de 
+  :%{key_after} (%{h_after})…
+221: >
+  La table de donnée pour le noeud :%{noeud} doit définir le temps
+  (avec la clé :t ou :time).
+222: >
+  La table de donnée pour le noeud :%{noeud} doit définir la description
+  humaine du noeud, à l'aide des clés :d ou :description.
+
+# --- Image (building) ---
+
+5000: >
+  L'image '%{path}' n'a pas pu être produite.
+  (pour une raison malheureusement inconnue de nos services…)
+
+5001: >
+  Une erreur s'est produite avec la commande `convert' :
+  %{error}.

data/lib/pfa/absolute_pfa.rb

@@ -0,0 +1,25 @@
+#
+# Singleton AbsolutePFA
+# ---------------------
+# 
+# 
+# @note
+# 
+#   Les DATA absolues du paradigme sont définies dans le fichier
+#   PFA_ABSOLUTE_DATA.yaml dans le dossier assets/<LANG>
+# 
+module PFA
+class AbsolutePFAClass
+  include Singleton
+
+  # @return Data absolues du Paradigme de Field Augmenté
+  # 
+  def data
+    @data ||= YAML.load_file(ABSOLUTE_DATA_PATH, **{symbolize_names:true})
+  end
+
+end #/ AbsolutePFAClass
+
+AbsolutePFA = AbsolutePFAClass.instance
+
+end #/ module PFA

data/lib/pfa/any_builder.rb

@@ -0,0 +1,28 @@
+module PFA
+class RelativePFA
+class AnyBuilder
+
+  #
+  # Les nœuds minimums pour pouvoir construire un PFA
+  # 
+  REQUIRED_NODES_FOR_BUILDING = [
+    :exposition,
+    :incident_declencheur,
+    :pivot1,
+    :developpement_part1,
+    :developpement_part2,
+    :pivot2,
+    :denouement,
+    :climax,
+  ]
+
+  # Instance \PFA::RelativePFA du paradigme de Field augmenté
+  attr_reader :pfa
+
+  def initialize(pfa)
+    @pfa = pfa
+  end
+  
+end #/class AnyBuilder
+end #/class RelativePFA
+end #/module PFA

data/lib/pfa/constants.rb

@@ -0,0 +1,24 @@
+module PFA
+
+  #
+  # La langue, pour le moment fixe
+  # 
+  LANG = 'fr'
+
+  #
+  # Chemin d'accès au dossier ASSETS
+  # 
+  ASSETS_FOLDER = File.absolute_path(File.join('.','lib','assets'))
+
+  #
+  # Chemin d'accès au dossier de LANGUE dans les ASSETS
+  # 
+  ASSETS_LANG_FOLDER = File.join(ASSETS_FOLDER, LANG)
+
+  #
+  # Chemin d'accès au fichier définissant les données absolues du
+  # Paradigme de Field Augmenté
+  # 
+  ABSOLUTE_DATA_PATH = File.join(ASSETS_LANG_FOLDER,'PFA_ABSOLUTE_DATA.yaml')
+
+end #/ module PFA

data/lib/pfa/errors_manager.rb

@@ -0,0 +1,14 @@
+module PFA
+
+  class PFAFatalError < StandardError 
+    def initialize(err_num, params = nil)
+      err_msg = ERRORS[err_num]
+      err_msg = err_msg % params unless params.nil?
+      super(err_msg)
+    end
+  end
+  class PFAError < StandardError; end
+
+  ERRORS = YAML.load_file(File.join(ASSETS_LANG_FOLDER,'errors.yaml'))
+
+end #/module PFA