Class: Project

Inherits:
ApplicationRecord show all
Includes:
Housekeeping::AssociationHelpers, Housekeeping::Timestamps, Housekeeping::Users, Preferences
Defined in:
app/models/project.rb,
app/models/project/preferences.rb

Overview

A project is a team's wrapper for a group of data. Most data is project specific, with a few exceptions. A project has many users, and one or more project administrators. With the exception of “Workers” who can only see and therefore use certain elements of the workbench all members of a project share the same privileges. A projects members are therefor well trained and trusted contributors to the project.

Defined Under Namespace

Modules: Preferences

Constant Summary

MANIFEST =

ORDER MATTERS Used in nuke order (not available in production UI), but ultimately also for dumping records

%w{
Label
Attribution
DwcOccurrence
ProtocolRelationship
CharacterState
Protocol
AlternateValue
DataAttribute
CitationTopic
Citation
SqedDepiction
Depiction
Documentation
Document
CollectionObjectObservation
DerivedCollectionObject
Note
PinboardItem
TaggedSectionKeyword
Tag
Confidence
Role
AssertedDistribution
BiocurationClassification
BiologicalRelationshipType
BiologicalAssociationsBiologicalAssociationsGraph
BiologicalAssociation
BiologicalRelationship
BiologicalAssociationsGraph
CollectionProfile
ContainerItem
Container
PublicContent
Content
Georeference
Identifier
LoanItem
Loan
OtuPageLayoutSection
OtuPageLayout
ProjectSource
TaxonDetermination
TypeMaterial
CollectionObject
CollectingEvent
RangedLotCategory
Image
CommonName
Otu
TaxonNameClassification
TaxonNameRelationship
TaxonName
ControlledVocabularyTerm
OriginRelationship
Sequence
SequenceRelationship
Observation
Extract
GeneAttribute
ObservationMatrixColumnItem
ObservationMatrixColumn
ObservationMatrixRowItem
ObservationMatrixRow
ObservationMatrix
Descriptor
ProjectMember

Constants included from Preferences

Preferences::BASE_PREFERENCES

Instance Attribute Summary (collapse)

Attributes included from Housekeeping::Users

#by

Class Method Summary (collapse)

Instance Method Summary (collapse)

Methods included from Preferences

#fill_preferences, #layout=, #reset_preferences

Methods included from Housekeeping::AssociationHelpers

#has_many_relationship_classes, #has_many_relationships

Methods included from Housekeeping::Timestamps

#data_breakdown_for_chartkick_recent

Methods included from Housekeeping::Users

#set_created_by_id, #set_updated_by_id

Instance Attribute Details

- (String) name

Returns The name of the project

Returns:

  • (String)

    The name of the project



13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
# File 'app/models/project.rb', line 13

class Project < ApplicationRecord
  include Housekeeping::Users
  include Housekeeping::Timestamps
  include Housekeeping::AssociationHelpers
  include Project::Preferences

  attr_accessor :without_root_taxon_name

  # ORDER MATTERS
  # Used in nuke order (not available in production UI), but 
  # ultimately also for dumping records
  MANIFEST = %w{
     Label
     Attribution
     DwcOccurrence
     ProtocolRelationship
     CharacterState
     Protocol
     AlternateValue
     DataAttribute
     CitationTopic
     Citation
     SqedDepiction
     Depiction
     Documentation
     Document
     CollectionObjectObservation
     DerivedCollectionObject
     Note
     PinboardItem
     TaggedSectionKeyword
     Tag
     Confidence
     Role
     AssertedDistribution
     BiocurationClassification
     BiologicalRelationshipType
     BiologicalAssociationsBiologicalAssociationsGraph
     BiologicalAssociation
     BiologicalRelationship
     BiologicalAssociationsGraph
     CollectionProfile
     ContainerItem
     Container
     PublicContent
     Content
     Georeference
     Identifier
     LoanItem
     Loan
     OtuPageLayoutSection
     OtuPageLayout
     ProjectSource
     TaxonDetermination
     TypeMaterial
     CollectionObject
     CollectingEvent
     RangedLotCategory
     Image
     CommonName
     Otu
     TaxonNameClassification
     TaxonNameRelationship
     TaxonName
     ControlledVocabularyTerm
     OriginRelationship
     Sequence
     SequenceRelationship
     Observation
     Extract
     GeneAttribute
     ObservationMatrixColumnItem
     ObservationMatrixColumn
     ObservationMatrixRowItem
     ObservationMatrixRow
     ObservationMatrix
     Descriptor
     ProjectMember
    }
  
  has_many :project_members, dependent: :restrict_with_error
  has_many :users, through: :project_members
  has_many :project_sources, dependent: :restrict_with_error
  has_many :sources, through: :project_sources


  after_create :create_root_taxon_name, unless: -> {self.without_root_taxon_name == true}

  validates_presence_of :name
  validates_uniqueness_of :name

  # !! This is not production ready.
  # @return [Boolean]
  #   based on whether the project has successfully been deleted.  Can also raise on detected problems with configuration.
  def nuke
    known = ApplicationRecord.subclasses.select {|a| a.column_names.include?('project_id')}.map(&:name)

    known.each do |k|
      next if k.constantize.table_name == 'test_classes' # TODO: a kludge to ignore stubbed classes in testing
      if !MANIFEST.include?(k)
        raise "#{k} has not been added to #nuke order."
      end
    end

    begin
      MANIFEST.each do |o|
        klass = o.constantize
        klass.where(project_id: id).delete_all
      end

      self.destroy

      true
    rescue => e
      raise e
    end
  end

  # TODO: boot load checks
  def root_taxon_name
    # Calling TaxonName is a hack to load the required has_many into Project,
    # "has_many :taxon_names" is invoked through TaxonName within Housekeeping::Project
    # Within TaxonName closure_tree (appears to?) require a database connection. 

    # Since we shouldn't (can't?) initiate a connection prior to a require_dependency
    # we simply load TaxonName for the first time here.
    TaxonName.tap {} # TODO: move to require_dependency?
    TaxonNameRelationship.tap {}
    taxon_names.root
  end

  def self.find_for_autocomplete(params)
    where('name LIKE ?', "#{params[:term]}%")
  end

  protected

  def create_root_taxon_name
    p = Protonym.stub_root(project_id: id, by: creator)
    p.save!
    p
  end

end

- (Hash) preferences

Returns Settings for the project (for all users)

Returns:

  • (Hash)

    Settings for the project (for all users)



13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
# File 'app/models/project.rb', line 13

class Project < ApplicationRecord
  include Housekeeping::Users
  include Housekeeping::Timestamps
  include Housekeeping::AssociationHelpers
  include Project::Preferences

  attr_accessor :without_root_taxon_name

  # ORDER MATTERS
  # Used in nuke order (not available in production UI), but 
  # ultimately also for dumping records
  MANIFEST = %w{
     Label
     Attribution
     DwcOccurrence
     ProtocolRelationship
     CharacterState
     Protocol
     AlternateValue
     DataAttribute
     CitationTopic
     Citation
     SqedDepiction
     Depiction
     Documentation
     Document
     CollectionObjectObservation
     DerivedCollectionObject
     Note
     PinboardItem
     TaggedSectionKeyword
     Tag
     Confidence
     Role
     AssertedDistribution
     BiocurationClassification
     BiologicalRelationshipType
     BiologicalAssociationsBiologicalAssociationsGraph
     BiologicalAssociation
     BiologicalRelationship
     BiologicalAssociationsGraph
     CollectionProfile
     ContainerItem
     Container
     PublicContent
     Content
     Georeference
     Identifier
     LoanItem
     Loan
     OtuPageLayoutSection
     OtuPageLayout
     ProjectSource
     TaxonDetermination
     TypeMaterial
     CollectionObject
     CollectingEvent
     RangedLotCategory
     Image
     CommonName
     Otu
     TaxonNameClassification
     TaxonNameRelationship
     TaxonName
     ControlledVocabularyTerm
     OriginRelationship
     Sequence
     SequenceRelationship
     Observation
     Extract
     GeneAttribute
     ObservationMatrixColumnItem
     ObservationMatrixColumn
     ObservationMatrixRowItem
     ObservationMatrixRow
     ObservationMatrix
     Descriptor
     ProjectMember
    }
  
  has_many :project_members, dependent: :restrict_with_error
  has_many :users, through: :project_members
  has_many :project_sources, dependent: :restrict_with_error
  has_many :sources, through: :project_sources


  after_create :create_root_taxon_name, unless: -> {self.without_root_taxon_name == true}

  validates_presence_of :name
  validates_uniqueness_of :name

  # !! This is not production ready.
  # @return [Boolean]
  #   based on whether the project has successfully been deleted.  Can also raise on detected problems with configuration.
  def nuke
    known = ApplicationRecord.subclasses.select {|a| a.column_names.include?('project_id')}.map(&:name)

    known.each do |k|
      next if k.constantize.table_name == 'test_classes' # TODO: a kludge to ignore stubbed classes in testing
      if !MANIFEST.include?(k)
        raise "#{k} has not been added to #nuke order."
      end
    end

    begin
      MANIFEST.each do |o|
        klass = o.constantize
        klass.where(project_id: id).delete_all
      end

      self.destroy

      true
    rescue => e
      raise e
    end
  end

  # TODO: boot load checks
  def root_taxon_name
    # Calling TaxonName is a hack to load the required has_many into Project,
    # "has_many :taxon_names" is invoked through TaxonName within Housekeeping::Project
    # Within TaxonName closure_tree (appears to?) require a database connection. 

    # Since we shouldn't (can't?) initiate a connection prior to a require_dependency
    # we simply load TaxonName for the first time here.
    TaxonName.tap {} # TODO: move to require_dependency?
    TaxonNameRelationship.tap {}
    taxon_names.root
  end

  def self.find_for_autocomplete(params)
    where('name LIKE ?', "#{params[:term]}%")
  end

  protected

  def create_root_taxon_name
    p = Protonym.stub_root(project_id: id, by: creator)
    p.save!
    p
  end

end

- (Object) without_root_taxon_name

Returns the value of attribute without_root_taxon_name



19
20
21
# File 'app/models/project.rb', line 19

def without_root_taxon_name
  @without_root_taxon_name
end

Class Method Details

+ (Object) find_for_autocomplete(params)



144
145
146
# File 'app/models/project.rb', line 144

def self.find_for_autocomplete(params)
  where('name LIKE ?', "#{params[:term]}%")
end

Instance Method Details

- (Object) create_root_taxon_name (protected)



150
151
152
153
154
# File 'app/models/project.rb', line 150

def create_root_taxon_name
  p = Protonym.stub_root(project_id: id, by: creator)
  p.save!
  p
end

- (Boolean) nuke

!! This is not production ready.

Returns:

  • (Boolean)

    based on whether the project has successfully been deleted. Can also raise on detected problems with configuration.



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
# File 'app/models/project.rb', line 107

def nuke
  known = ApplicationRecord.subclasses.select {|a| a.column_names.include?('project_id')}.map(&:name)

  known.each do |k|
    next if k.constantize.table_name == 'test_classes' # TODO: a kludge to ignore stubbed classes in testing
    if !MANIFEST.include?(k)
      raise "#{k} has not been added to #nuke order."
    end
  end

  begin
    MANIFEST.each do |o|
      klass = o.constantize
      klass.where(project_id: id).delete_all
    end

    self.destroy

    true
  rescue => e
    raise e
  end
end

- (Object) root_taxon_name

TODO: boot load checks



132
133
134
135
136
137
138
139
140
141
142
# File 'app/models/project.rb', line 132

def root_taxon_name
  # Calling TaxonName is a hack to load the required has_many into Project,
  # "has_many :taxon_names" is invoked through TaxonName within Housekeeping::Project
  # Within TaxonName closure_tree (appears to?) require a database connection. 

  # Since we shouldn't (can't?) initiate a connection prior to a require_dependency
  # we simply load TaxonName for the first time here.
  TaxonName.tap {} # TODO: move to require_dependency?
  TaxonNameRelationship.tap {}
  taxon_names.root
end