espace_membre-ruby 0.4.1 → 1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b0e3692f295d3f9155807570eb17711b8cfd900ce0081e982e36248316f8bc8b
-  data.tar.gz: bbf1dfa5c0907491887a09a6803064b7a6e238c33ee5a29b2af90f4de635c7ed
+  metadata.gz: 1e66c2d89ac50c90ae52377f4770cb6d040802a6280d42b0dac58ce3a026096e
+  data.tar.gz: 80e88388d15e162e942ca5d21b54d0471ac4a1ebd34e7f864a92924a7207dfc5
 SHA512:
-  metadata.gz: 2843954aa3366b34c280b1e46c511da4be753f2c568ecff1e6f3449860ce66fe562871901528bac8b58e7aee1d9cef3d31e23158b0462bd7e129613dd38776cc
-  data.tar.gz: '09b9734b2d34c322f28269332ea93c6675b7903681da52eccd9972437e7719fa0e557c40615e33ac83b2d3d0b3ede2519d7347904379616f9c102057e16987a1'
+  metadata.gz: 9733a430af728a4ae862f85533ca6a9b43fa8585afe2c876d39d243408e57c341429e927c173bd21018c8ac8cba8dd06dd4ab9474ee1091147659c8d604d12f6
+  data.tar.gz: 0c5023c0b4721818b9947c262655fb345578afcb2f279167f1f7d211f2bb14e0dcb290e64cc7406b85fe98fdbde17c04c83c0afa66a84a4abf3a77e141687102

data/README.md

@@ -1,24 +1,42 @@
 # espace_membre-ruby
 
-This gem offers some glue (namely ActiveRecord models) around the
-Espace-Membre database to allow writing simple Ruby apps around it.
-
-## TODO
-
-- [ ] allow configuration (database name)
-- [X] restore RSpec
-- [X] run the tests
-- [X] distribute.
+Cette gem fournit des classes ActiveRecord communes pour encapsuler et
+partager la logique de l'Espace-Membre. Elle est [déjà
+utilisée](https://github.com/betagouv/espace_membre-ruby/network/dependents)
+par d'autres produits pour construire autour des données beta.gouv.fr
+et leurs logique métier (ex: "est-ce qu'un produit est actif ?", "qui
+est considéré alumni", etc).
 
 ## Installation
-Add this line to your application's Gemfile:
+
+Dans votre Gemfile:
 
 ```ruby
 gem "espace_membre-ruby"
 ```
 
-Then start having fun:
+Puis vous devez indiquer à Rails la base de données de Beta au travers
+d'une nouvelle base `espace_membre_db`, c.f [la configuration de
+standards.beta.gouv.fr](https://github.com/betagouv/standards-front/blob/main/config/database.yml#L1-L6).
+
+Ensuite vous pouvez lancer votre console et vérifier que le connecteur
+fonctionne bien :
 
 ```ruby
 EspaceMembre::User.without(:active_missions).last(10)
 ```
+
+## Documentation
+
+Pas encore disponible mais vous pouvez [consulter la liste des
+modèles](https://github.com/betagouv/espace_membre-ruby/tree/main/lib/espace_membre)
+ou [les tests
+associés](https://github.com/betagouv/espace_membre-ruby/blob/53e282c9e3afff9bd4fbaf7bd0cf15734756e9cc/spec/dummy/spec/models/user_spec.rb#L30)
+pour explorer la gem.
+
+## TODO
+
+- [ ] allow configuration (database name)
+- [X] restore RSpec
+- [X] run the tests
+- [X] distribute.

data/lib/espace_membre/incubator.rb

@@ -1,7 +1,5 @@
 module EspaceMembre
   class Incubator < Record
-    self.primary_key = "uuid"
-
     validates :ghid, presence: true
 
     has_many :startups

data/lib/espace_membre/mission.rb

@@ -2,8 +2,6 @@
 
 module EspaceMembre
   class Mission < Record
-    self.primary_key = "uuid"
-
     belongs_to :user
 
     has_and_belongs_to_many :startups, join_table: "missions_startups"

data/lib/espace_membre/mission_startup.rb

@@ -3,7 +3,6 @@
 module EspaceMembre
   class MissionStartup < Record
     self.table_name = "missions_startups"
-    self.primary_key = "uuid"
 
     belongs_to :mission
     belongs_to :startup_id

data/lib/espace_membre/organization.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module EspaceMembre
+  class Organization < Record
+    has_and_belongs_to_many :startups, join_table: "startups_organizations"
+
+    # EMDB has a `type` column which triggers ActiveRecord – but still
+    # it is still kind enough to provide the following fix:
+    self.inheritance_column = :null
+  end
+end

data/lib/espace_membre/phase.rb

@@ -2,20 +2,24 @@ module EspaceMembre
   class Phase < Record
     belongs_to :startup
 
-    PHASES = [
-      "investigation",
-      "construction",
-      "acceleration",
-      "success",
-      "alumni",
-      "transfer"
+    PHASES = %w[
+      investigation
+      abandon-investigation
+      construction
+      acceleration
+      consolidation
+      abandon
+      opere
+      transfere
     ]
 
-    # FIXME: at the moment multiple ongoing/active (i.e no end date)
-    # phases for the same startup can coexist happily, we must fix the
-    # data and make this a valid statement.
-    #
-    # scope :active, -> { where("end" => nil) } # this does NOT work
+    ACTIVE_PHASES = %w[
+      acceleration
+      consolidation
+      construction
+      investigation
+      opere
+    ].freeze
 
     PHASES.each do |phase|
       # define scopes for each state (Phase.success, Phase.alumni, etc.)
@@ -27,12 +31,6 @@ module EspaceMembre
       end
     end
 
-    scope :active_phase, -> { construction.or(acceleration) }
-
-    def terminate!
-      update!(end: Time.zone.now)
-    end
-
     def to_s
       name
     end

data/lib/espace_membre/railtie.rb

@@ -6,6 +6,7 @@ module EspaceMembre
         require "espace_membre/incubator.rb"
         require "espace_membre/mission.rb"
         require "espace_membre/mission_startup.rb"
+        require "espace_membre/organization.rb"
         require "espace_membre/phase.rb"
         require "espace_membre/startup.rb"
         require "espace_membre/user.rb"

data/lib/espace_membre/record.rb

@@ -1,5 +1,6 @@
 module EspaceMembre
   class Record < ActiveRecord::Base
+    self.primary_key = "uuid"
     self.abstract_class = true
 
     connects_to database: { writing: :espace_membre_db, reading: :espace_membre_db }

data/lib/espace_membre/startup.rb

@@ -1,13 +1,13 @@
 module EspaceMembre
   class Startup < Record
-    self.primary_key = "uuid"
-
     validates :ghid, presence: true
 
     belongs_to :incubator
 
     has_many :phases
 
+    has_and_belongs_to_many :organizations, join_table: "startups_organizations"
+
     has_and_belongs_to_many :missions, join_table: "missions_startups"
 
     has_many :users, through: :missions
@@ -19,6 +19,8 @@ module EspaceMembre
             class_name: "Phase",
             inverse_of: :startup
 
+    scope :active, -> { in_phase(EspaceMembre::Phase::ACTIVE_PHASES) }
+
     # we must use this tragic hack because a startup can have one or
     # more phases without an 'end' timestamp, which is wrong and
     # misleading but that's how the data exists. So instead of
@@ -31,14 +33,8 @@ module EspaceMembre
         .where("phases.start = (SELECT MAX(p2.start) FROM phases p2 WHERE p2.startup_id = startups.uuid)")
     }
 
-    Phase::PHASES.each do |name|
-      define_method "in_#{name}?" do
-        latest_phase.send("#{name}?")
-      end
-    end
-
     def in_phase?(name)
-      send("in_#{name}?")
+      latest_phase.name == name.to_s
     end
 
     def to_s

data/lib/espace_membre/team.rb

@@ -1,7 +1,5 @@
 module EspaceMembre
   class Team < Record
-    self.primary_key = "uuid"
-
     validates :ghid, presence: true
 
     belongs_to :incubator

data/lib/espace_membre/user.rb

@@ -28,6 +28,13 @@ module EspaceMembre
     validates :username, :fullname, :role, :domaine, presence: true
     validates :domaine, inclusion: { in: DOMAINES }
 
+    scope :expired, -> {
+      where(
+        "NOT EXISTS (:active_missions)",
+        active_missions: Mission.active.where("missions.user_id = users.uuid")
+      )
+    }
+
     def self.identify_email!(email)
       User.find_by!(primary_email: email)
     rescue ActiveRecord::RecordNotFound

data/lib/espace_membre/version.rb

@@ -1,3 +1,3 @@
 module EspaceMembre
-  VERSION = "0.4.1"
+  VERSION = "1.0"
 end

data/spec/dummy/spec/factories/startups.rb

@@ -18,8 +18,6 @@ FactoryBot.define do
       in_investigation
 
       after(:create) do |startup|
-        startup.latest_phase.terminate!
-
         FactoryBot.create(:phase, :construction, startup: startup)
       end
     end
@@ -28,10 +26,16 @@ FactoryBot.define do
       in_construction
 
       after(:create) do |startup|
-        startup.latest_phase.terminate!
-
         FactoryBot.create(:phase, :acceleration, startup: startup)
       end
     end
+
+    trait :abandon_investigation do
+      in_investigation
+
+      after(:create) do |startup|
+        FactoryBot.create(:phase, :"abandon-investigation", startup: startup)
+      end
+    end
   end
 end

data/spec/dummy/spec/factories/users.rb

@@ -18,6 +18,18 @@ FactoryBot.define do
       end
     end
 
+    trait :with_expired_mission do
+      with_active_mission
+
+      transient do
+        mission_end { Date.yesterday }
+      end
+
+      after(:create) do |user, context|
+        user.missions.last.update!(end: context.mission_end)
+      end
+    end
+
     trait :with_active_startup do
       with_active_mission
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: espace_membre-ruby
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: '1.0'
 platform: ruby
 authors:
 - Stéphane Maniaci
@@ -36,6 +36,7 @@ files:
 - lib/espace_membre/incubator.rb
 - lib/espace_membre/mission.rb
 - lib/espace_membre/mission_startup.rb
+- lib/espace_membre/organization.rb
 - lib/espace_membre/phase.rb
 - lib/espace_membre/railtie.rb
 - lib/espace_membre/record.rb