Questions to consider:
Guidance:
Give a brief description of the data, including any existing data or third-party sources that will be used, in each case noting its content, type and coverage. Outline and justify your choice of format and consider the implications of data format and data volumes in terms of storage, backup and access.
", - themes: ["Theme 2"] - }, - "How will the data be collected or created?" => { - text: "How will the data be collected or created?", - section: "Data Collection", - number: 2, - guidance: "Questions to consider:
Guidance:
Outline how the data will be collected/created and which community data standards (if any) will be used. Consider how the data will be organised during the project, mentioning for example naming conventions, version control and folder structures. Explain how the consistency and quality of data collection will be controlled and documented. This may include processes such as calibration, repeat samples or measurements, standardised data capture or recording, data entry validation, peer review of data or representation with controlled vocabularies.
", - themes: ["Theme 3"] - }, - "What documentation and metadata will accompany the data?" => { - text: "What documentation and metadata will accompany the data?", - section: "Documentation and Metadata", - number: 1, - guidance: "Questions to consider:
Guidance:
Describe the types of documentation that will accompany the data to help secondary users to understand and reuse it. This should at least include basic details that will help people to find the data, including who created or contributed to the data, its title, date of creation and under what conditions it can be accessed.
Documentation may also include details on the methodology used, analytical and procedural information, definitions of variables, vocabularies, units of measurement, any assumptions made, and the format and file type of the data. Consider how you will capture this information and where it will be recorded. Wherever possible you should identify and use existing community standards.
", - themes: ["Theme 1"] - }, - "Data Overview" => { - text: "Overview of the Data", - section: "Data Overview", - number: 1, - guidance: "Things to consider:
Things to consider:
Questions to consider:
Guidance:
Ethical issues affect how you store data, who can see/use it and how long it is kept. Managing ethical concerns may include: anonymisation of data; referral to departmental or institutional ethics committees; and formal consent agreements. You should show that you are aware of any issues and have planned accordingly. If you are carrying out research involving human participants, you must also ensure that consent is requested to allow data to be shared and reused.
", - themes: ["Theme 4"] - }, - "How will you manage copyright and Intellectual Property Rights (IPR) issues?" => { - text: "How will you manage copyright and Intellectual Property Rights (IPR) issues?", - section: "Ethics and Legal Compliance", - number: 2, - guidance: "Questions to consider:
Guidance:
State who will own the copyright and IPR of any data that you will collect or create, along with the licence(s) for its use and reuse. For multi-partner projects, IPR ownership may be worth covering in a consortium agreement. Consider any relevant funder, institutional, departmental or group policies on copyright or IPR. Also consider permissions to reuse third-party data and any restrictions needed on data sharing.
", - themes: ["Theme 1"] - }, - "How will the data be stored and backed up during the research?" => { - text: "How will the data be stored and backed up during the research?", - section: "Storage and Backup", - number: 1, - guidance: "Questions to consider:
Guidance:
State how often the data will be backed up and to which locations. How many copies are being made? Storing data on laptops, computer hard drives or external storage devices alone is very risky. The use of robust, managed storage provided by university IT teams is preferable. Similarly, it is normally better to use automatic backup services provided by IT Services than rely on manual processes. If you choose to use a third-party service, you should ensure that this does not conflict with any funder, institutional, departmental or group policies, for example in terms of the legal jurisdiction in which data are held or the protection of sensitive data.
", - themes: ["Theme 2"] - }, - "4a: Preserving Your Data" => { - text: "4a: Preserving Your Data", - section: "Preservation, Sustainability and Use", - number: 1, - guidance: "Preservation of digital outputs is necessary in order for them to endure changes in the technological environment and remain potentially re-usable in the future. In this section you must state what, if any, digital outputs of your project you intend to preserve beyond the period of funding.
The length and cost of preservation should be proportionate to the value and significance of the digital outputs. If you believe that none of these should be preserved this must be justified, and if the case is a good one the application will not be prejudiced.
You must consider preservation in four ways: what, where, how and for how long. You must also consider any institutional support needed in order to carry out these plans, whether from an individual, facility, organisation or service.
You should think about the possibilities for re-use of your data in other contexts and by other users, and connect this as appropriate with your plans for dissemination and Pathways to Impact.Where there is potential for re-usability, you should use standards and formats that facilitate this.
The Technical Reviewer will be looking for evidence that you understand the reasons for the choice of technical standards and formats described in Section 2.a Technical Methodology: Standards and Formats.
You should describe the types of documentation which will accompany the data. Documentation in this sense means technical documentation as well as user documentation. It includes, for instance, technical description, code commenting, project-build guidelines, the documentation of technical decisions and resource metadata which is additional to the standards which you have described in Section 2.a. Not all types of documentation will be relevant to a project and the quantity of documentation proposed should be proportionate to the envisaged value of the data.
", - themes: ["Theme 2", "Theme 3", "Theme 4"] - }, - "4b: Ensuring Continued Accessibility and Use of Your Digital Outputs" => { - text: "4b: Ensuring Continued Accessibility and Use of Your Digital Outputs", - section: "Preservation, Sustainability and Use", - number: 2, - guidance: "In this section you must provide information about any plans for ensuring that digital outputs remain sustainable in the sense of immediately accessible and usable beyond the period of funding. There are costs to ensuring sustainability in this sense over and above the costs of preservation. The project's sustainability plan should therefore be proportionate to the envisaged longer-term value of the data for the research community and should be closely related to your plans for dissemination and Pathways to Impact.
If you believe that digital outputs should not be sustained beyond the period of funding then this should be justified. It is not mandatory to sustain all digital outputs. While you should consider the long-term value of the digital outputs to the research community, where they are purely ancillary to a project’s research outputs there may not be a case for sustaining them (though there would usually be a case for preservation).
You must consider the sustainability of your digital outputs in five ways: what, where, how, for how long, and how the cost will be covered. You must make appropriate provision for user consultation and user testing in this connection, and plan the development of suitable user documentation.
You should provide justification if you do not envisage open, public access. A case can be made for charging for or otherwise limiting access, but the default expectation is that access will be open. The Technical Reviewer will be looking for realistic commitments to sustaining public access in line with affordability and the longer-term value of the digital output.
You must consider any institutional support needed in order to carry out these plans, if not covered under Section 3, as well as the cost of keeping the digital output publicly available in the future, including issues relating to maintenance, infrastructure and upgrade (such as the need to modify aspects of a web interface or software application in order to account for changes in the technological environment). In order to minimise sustainability costs, it is generally useful that the expertise involved in the development of your project is supported by expertise in your own or a partner institution.
A sustainability plan does not necessarily mean a requirement to generate income or prevent resources from being freely available. Rather it is a requirement to consider the direct costs and expertise of maintaining digital outputs for continued access. Some applicants might be able to demonstrate that there will be no significant sustainability problems with their digital output; in some cases the university’s computing services or library might provide a firm commitment to sustaining the resource for a specified period; others might see the benefit of Open Source community development models. You should provide reassurances of sustainability which are proportionate to the envisaged longer-term value of the digital outputs for the research community.
When completing this section, you should consider the potential impact of the data on research in your field (if research in the discipline will be improved through the creation of the digital output, how will it be affected if the resource then disappears?), and make the necessary connections with your Impact Plan. You must factor in the effects of any IP, copyright and ethical issues during the period in which the digital output will be publicly accessible, connecting what you say with the relevant part of your Case for Support.
You must identify whether or not you envisage the academic content (as distinct from the technology) of the digital output being extended or updated beyond the period of funding, addressing the following issues: how this will be done, by who and at what cost. You will need to show how the cost of this will be sustained after the period of funding ends.
", - themes: ["Theme 2"] - } - } - - questions.each do |q, details| - if Question.where(text: details[:text]).empty? - question = Question.new - question.text = details[:text] - question.number = details[:number] - question.guidance = details[:guidance] - question.section = Section.find_by_title(details[:section]) - details[:themes].each do |theme| - question.themes << Theme.find_by_title(theme) - end - question.save! - end - end - -formatting = { - 'Funder' => { - font_face: "Arial, Helvetica, Sans-Serif", - font_size: 11, - margin: { top: 20, bottom: 20, left: 20, right: 20 } - }, - 'DCC' => { - font_face: "Arial, Helvetica, Sans-Serif", - font_size: 12, - margin: { top: 20, bottom: 20, left: 20, right: 20 } - } -} - -formatting.each do |org, settings| - #template = Dmptemplate.find_by_title("#{org} Template") # this is bugged, there is no Funder Template nor DCC template - #template.settings(:export).formatting = settings - #template.save! -end - -token_permission_types = { - 'guidances' => { - description: "allows a user access to the guidances api endpoint" - }, - 'plans' => { - description: "allows a user access to the plans api endpoint" - }, - 'templates' => { - description: "allows a user access to the templates api endpoint" - }, - 'statistics' => { - description: "allows a user access to the statistics api endpoint" - } -} - -token_permission_types.each do |title,settings| - if TokenPermissionType.where(token_type: title).empty? - token_permission_type = TokenPermissionType.new - token_permission_type.token_type = title - token_permission_type.text_description = settings[:description] - token_permission_type.save! end end + +# Regions (create the super regions first and then create the rest) +# ------------------------------------------------------- +regions = [ + {abbreviation: 'horizon', + description: 'European super region', + name: 'Horizon2020', + sub_regions: [ + {abbreviation: 'uk', + description: 'United Kingdom', + name: 'UK'}, + {abbreviation: 'de', + description: 'Germany', + name: 'DE'}, + {abbreviation: 'fr', + description: 'France', + name: 'FR'}, + {abbreviation: 'es', + description: 'Spain', + name: 'ES'} + ]}, + {abbreviation: 'us', + description: 'United States of America', + name: 'US'} +] + +# Create the region. If it has subregions create them and then connect them +regions.each do |r| + srs = r[:sub_regions] + r.delete(:sub_regions) unless r[:sub_regions].nil? + + if Region.find_by(abbreviation: r[:abbreviation]).nil? + region = Region.create!(r) + + unless srs.nil? + srs.each do |sr| + if Region.find_by(abbreviation: sr[:abbreviation]).nil? + subregion = Region.create!(sr) + RegionGroup.create!({region_id: subregion.id, super_region_id: region.id}) + end + end + end + + end +end + +# Perms +# ------------------------------------------------------- +perms = [ + {name: 'add_organisations'}, + {name: 'change_org_affiliation'}, + {name: 'grant_permissions'}, + {name: 'modify_templates'}, + {name: 'modify_guidance'}, + {name: 'use_api'}, + {name: 'change_org_details'}, + {name: 'grant_api_to_orgs'} +] + +perms.map{ |p| Perm.create!(p) if Perm.find_by(name: p[:name]).nil? } + +# Guidance Themes +# ------------------------------------------------------- +themes = [ + {title: 'Data Description'}, + {title: 'Data Format'}, + {title: 'Data Volume'}, + {title: 'Data Collection'}, + {title: 'Metadata & Documentation'}, + {title: 'Ethics & Privacy'}, + {title: 'Intellectual Property Rights'}, + {title: 'Storage & Security'}, + {title: 'Data Sharing'}, + {title: 'Data Repository'}, + {title: 'Preservation'}, + {title: 'Roles & Responsibilities'}, + {title: 'Budget'}, + {title: 'Related Policies'} +] +themes.map{ |t| Theme.create!(t) if Theme.find_by(title: t[:title]).nil? } + +# Token Permission Types +# ------------------------------------------------------- +token_permission_types = [ + {token_type: 'guidances', text_description: 'allows a user access to the guidances api endpoint'}, + {token_type: 'plans', text_description: 'allows a user access to the plans api endpoint'} +] +token_permission_types.map{ |tpt| TokenPermissionType.create!(tpt) if TokenPermissionType.find_by(token_type: tpt[:token_type]).nil? } + +# Create our generic organisation, a funder and a University +# ------------------------------------------------------- +orgs = [ + {name: 'Curation Centre', + abbreviation: 'CC', + banner_text: 'This is an example organisation', + org_type: 3, + language: Language.find_by(abbreviation: 'en-UK'), + token_permission_types: TokenPermissionType.all}, + {name: 'Government Agency', + abbreviation: 'GA', + org_type: 2, + language: Language.find_by(abbreviation: 'en-UK')}, + {name: 'University of Exampleland', + abbreviation: 'UOS', + org_type: 1, + language: Language.find_by(abbreviation: 'en-UK')} +] +orgs.map{ |o| Org.create!(o) if Org.find_by(abbreviation: o[:abbreviation]).nil? } + +# Create a Super Admin associated with our generic organisation, +# an Org Admin for our funder and an Org Admin and User for our University +# ------------------------------------------------------- +users = [ + {email: "super_admin@example.com", + firstname: "Super", + surname: "Admin", + password: "password123", + password_confirmation: "password123", + organisation: Org.find_by(abbreviation: 'CC'), + language: Language.find_by(abbreviation: 'en-UK'), + perms: Perm.all, + accept_terms: true, + confirmed_at: Time.zone.now}, + {email: "funder_admin@example.com", + firstname: "Funder", + surname: "Admin", + password: "password123", + password_confirmation: "password123", + organisation: Org.find_by(abbreviation: 'GA'), + language: Language.find_by(abbreviation: 'en-UK'), + perms: Perm.where.not(name: ['admin', 'add_organisations', 'change_org_affiliation']), + accept_terms: true, + confirmed_at: Time.zone.now}, + {email: "org_admin@example.com", + firstname: "Organisational", + surname: "Admin", + password: "password123", + password_confirmation: "password123", + organisation: Org.find_by(abbreviation: 'UOS'), + language: Language.find_by(abbreviation: 'en-UK'), + perms: Perm.where.not(name: ['admin', 'add_organisations', 'change_org_affiliation']), + accept_terms: true, + confirmed_at: Time.zone.now}, + {email: "org_user@example.com", + firstname: "Organisational", + surname: "User", + password: "password123", + password_confirmation: "password123", + organisation: Org.find_by(abbreviation: 'UOS'), + language: Language.find_by(abbreviation: 'en-UK'), + accept_terms: true, + confirmed_at: Time.zone.now} +] +users.map{ |u| User.create!(u) if User.find_by(email: u[:email]).nil? } + +# Create a Guidance Group for our organisation and the funder +# ------------------------------------------------------- +guidance_groups = [ + {name: "Generic Guidance (provided by the example curation centre)", + org: Org.find_by(abbreviation: 'CC'), + optional_subset: true, + published: true}, + {name: "Government Agency Advice (Funder specific guidance)", + org: Org.find_by(abbreviation: 'GA'), + optional_subset: false, + published: true} +] +guidance_groups.map{ |gg| GuidanceGroup.create!(gg) if GuidanceGroup.find_by(name: gg[:name]).nil? } + +# Initialize with the generic Roadmap guidance and a sample funder guidance +# ------------------------------------------------------- +guidances = [ + {text: "● Give a summary of the data you will collect or create, noting the content, coverage and data type, e.g., tabular data, survey data, experimental measurements, models, software, audiovisual data, physical samples, etc. +● Consider how your data could complement and integrate with existing data, or whether there are any existing data or methods that you could reuse. +● If purchasing or reusing existing data, explain how issues such as copyright and IPR have been addressed. You should aim to m +inimise any restrictions on the reuse (and subsequent sharing) of third-party data.", + guidance_group: GuidanceGroup.first, + published: true, + themes: [Theme.find_by(title: 'Data Description')]}, + {text: "● Clearly note what format(s) your data will be in, e.g., plain text (.txt), comma-separated values (.csv), geo-referenced TIFF (.tif, .tfw). +● Explain why you have chosen certain formats. Decisions may be based on staff expertise, a preference for open formats, the standards accepted by data centres or widespread usage within a given community. +● Using standardised, interchangeable or open formats ensures the long-term usability of data; these are recommended for sharing and archiving. +● See UK Data Service guidance on recommended formats or DataONE Best Practices for file formats", + guidance_group: GuidanceGroup.first, + published: true, + themes: [Theme.find_by(title: 'Data Format')]}, + {text: "● Note what volume of data you will create in MB/GB/TB +● Consider the implications of data volumes in terms of storage, access and preservation. Do you need to include additional costs? +● Consider whether the scale of the data will pose challenges when sharing or transferring data between sites; if so, how will you address these challenges?", + guidance_group: GuidanceGroup.first, + published: true, + themes: [Theme.find_by(title: 'Data Volume')]}, + {text: "● Outline how the data will be collected and processed. This should cover relevant standards or methods, quality assurance and data organisation. +● Indicate how the data will be organised during the project, mentioning, e.g., naming conventions, version control and folder structures. Consistent, well-ordered research data will be easier to find, understand and reuse +● Explain how the consistency and quality of data collection will be controlled and documented. This may include processes such as calibration, repeat samples or measurements, standardised data capture, data entry validation, peer review of data or representation with controlled vocabularies. +● See the DataOne Best Practices for data quality", + guidance_group: GuidanceGroup.first, + published: true, + themes: [Theme.find_by(title: 'Data Collection')]}, + {text: "● What metadata will be provided to help others identify and discover the data? +● Researchers are strongly encouraged to use community metadata standards where these are in place. The Research Data Alliance offers a Directory of Metadata Standards. +● Consider what other documentation is needed to enable reuse. This may include information on the methodology used to collect the data, analytical and procedural information, definitions of variables, units of measurement, any assumptions made, the format and file type of the data and software used to collect and/or process the data. +● Consider how you will capture this information and where it will be recorded, e.g., in a database with links to each item, in a ‘readme’ text file, in file headers, etc. ", + guidance_group: GuidanceGroup.first, + published: true, + themes: [Theme.find_by(title: 'Metadata & Documentation')]}, + {text: "● Investigators carrying out research involving human participants should request consent to preserve and share the data. Do not just ask for permission to use the data in your study or make unnecessary promises to delete it at the end. +● Consider how you will protect the identity of participants, e.g., via anonymisation or using managed access procedures. +● Ethical issues may affect how you store and transfer data, who can see/use it and how long it is kept. You should demonstrate that you are aware of this and have planned accordingly. +● See UK Data Service guidance on consent for data sharing +● See ICPSR approach to confidentiality and Health Insurance Portability and Accountability Act (HIPAA) regulations for health research", + guidance_group: GuidanceGroup.first, + published: true, + themes: [Theme.find_by(title: 'Ethics & Privacy')]}, + {text: "● State who will own the copyright and IPR of any new data that you will generate. For multi-partner projects, IPR ownership should be covered in the consortium agreement. +● Outline any restrictions needed on data sharing, e.g., to protect proprietary or patentable data. +● Explain how the data will be licensed for reuse. See the DCC guide on How to license research data and EUDAT’s data and software licensing wizard.", + guidance_group: GuidanceGroup.first, + published: true, + themes: [Theme.find_by(title: 'Intellectual Property Rights')]}, + {text: "● Describe where the data will be stored and backed up during the course of research activities. This may vary if you are doing fieldwork or working across multiple sites so explain each procedure. +● Identify who will be responsible for backup and how often this will be performed. The use of robust, managed storage with automatic backup, for example, that provided by university IT teams, is preferable. Storing data on laptops, computer hard drives or external storage devices alone is very risky. +● See UK Data Service Guidance on data storage or DataONE Best Practices for storage +● Also consider data security, particularly if your data is sensitive e.g., detailed personal data, politically sensitive information or trade secrets. Note the main risks and how these will be managed. +● Identify any formal standards that you will comply with, e.g., ISO 27001. See the DCC Briefing Paper on Information Security Management -ISO 27000 and UK Data Service guidance on data security", + guidance_group: GuidanceGroup.first, + published: true, + themes: [Theme.find_by(title: 'Storage & Security')]}, + {text: "● How will you share the data e.g. deposit in a data repository, use a secure data service, handle data requests directly or use another mechanism? The methods used will depend on a number of factors such as the type, size, complexity and sensitivity of the data. +● When will you make the data available? Research funders expect timely release. They typically allow embargoes but not prolonged exclusive use. +● Who will be able to use your data? If you need to restricted access to certain communities or apply data sharing agreements, explain why. +● Consider strategies to minimise restrictions on sharing. These may include anonymising or aggregating data, gaining participant consent for data sharing, gaining copyright permissions, and agreeing a limited embargo period. +● How might your data be reused in other contexts? Where there is potential for reuse, you should use standards and formats that facilitate this, and ensure that appropriate metadata is available online so your data can be discovered. Persistent identifiers should be applied so people can reliably and efficiently find your data. They also help you to track citations and reuse.", + guidance_group: GuidanceGroup.first, + published: true, + themes: [Theme.find_by(title: 'Data Sharing')]}, + {text: "● Where will the data be deposited? If you do not propose to use an established repository, the data management plan should demonstrate that the data can be curated effectively beyond the lifetime of the grant. +● It helps to show that you have consulted with the repository to understand their policies and procedures, including any metadata standards. +● An international list of data repositories is available via Re3data and some universities or publishers provide lists of recommendations e.g. PLOS ONE recommended repositories", + guidance_group: GuidanceGroup.first, + published: true, + themes: [Theme.find_by(title: 'Data Repository')]}, + {text: "● Indicate which data are of long-term value and should be shared and/or preserved. +● Outline the plans for data sharing and preservation - how long will the data be retained and where will it be archived? +● Will additional resources be needed to prepare data for deposit or meet any charges from data repositories? See the DCC guide: How to appraise and select research data for curation or DataONE Best Practices: Identifying data with long-term value", + guidance_group: GuidanceGroup.first, + published: true, + themes: [Theme.find_by(title: 'Preservation')]}, + {text: "● Outline the roles and responsibilities for all activities, e.g., data capture, metadata production, data quality, storage and backup, data archiving & data sharing. Individuals should be named where possible. +● For collaborative projects you should explain the coordination of data management responsibilities across partners. +● See UK Data Service guidance on data management roles and responsibilities or DataONE Best Practices: Define roles and assign responsibilities for data management", + guidance_group: GuidanceGroup.first, + published: true, + themes: [Theme.find_by(title: 'Roles & Responsibilities')]}, + {text: "● Carefully consider and justify any resources needed to deliver the plan. These may include storage costs, hardware, staff time, costs of preparing data for deposit and repository charges. +● Outline any relevant technical expertise, support and training that is likely to be required and how it will be acquired. +● If you are not depositing in a data repository, ensure you have appropriate resources and systems in place to share and preserve the data. See UK Data Service guidance on costing data management", + guidance_group: GuidanceGroup.first, + published: true, + themes: [Theme.find_by(title: 'Budget')]}, + {text: "● Consider whether there are any existing procedures that you can base your approach on. If your group/department has local guidelines that you work to, point to them here. +● List any other relevant funder, institutional, departmental or group policies on data management, data sharing and data security. ", + guidance_group: GuidanceGroup.first, + published: true, + themes: [Theme.find_by(title: 'Related Policies')]}, + {text: "Please tell us how much data you plan to collect and what format it will be in once its deposited.", + guidance_group: GuidanceGroup.last, + published: true, + themes: [Theme.find_by(title: 'Data Description')]} +] +guidances.map{ |g| Guidance.create!(g) if Guidance.find_by(text: g[:text]).nil? } + +# Create a default template for the curation centre and one for the example funder +# ------------------------------------------------------- +templates = [ + {title: "My Curation Center's Default Template", + description: "The default template", + published: true, + org: Org.find_by(abbreviation: 'CC'), + is_default: true, + version: 1}, + + {title: "OLD - Department of Testing Award", + published: false, + org: Org.find_by(abbreviation: 'GA'), + is_default: false, + version: 1}, + + {title: "Department of Testing Award", + published: true, + org: Org.find_by(abbreviation: 'GA'), + is_default: false, + version: 2} +] +templates.map{ |t| Template.create!(t) if Template.find_by(title: t[:title]).nil? } + +# Create 2 phases for the funder's template and one for our generic template +# ------------------------------------------------------- +phases = [ + {title: "Generic Data Management Planning Template", + number: 1, + modifiable: false, + template: Template.find_by(title: "My Curation Center's Default Template")}, + + {title: "Detailed Overview", + number: 1, + modifiable: false, + template: Template.find_by(title: "OLD - Department of Testing Award")}, + + {title: "Preliminary Statement of Work", + number: 1, + modifiable: true, + template: Template.find_by(title: "Department of Testing Award")}, + {title: "Detailed Overview", + number: 2, + modifiable: false, + template: Template.find_by(title: "Department of Testing Award")} +] +phases.map{ |p| Phase.create!(p) if Phase.find_by(title: p[:title]).nil? } + +generic_template_phase_1 = Phase.find_by(title: "Generic Data Management Planning Template") +funder_template_phase_1 = Phase.find_by(title: "Preliminary Statement of Work") +funder_template_phase_2 = Phase.find_by(title: "Detailed Overview") + +# Create sections for the 2 templates and their phases +# ------------------------------------------------------- +sections = [ + # Sections for the Generic Template + {title: "Data Collection", + number: 1, + published: true, + modifiable: false, + phase: generic_template_phase_1}, + {title: "Documentation and Metadata", + number: 2, + published: true, + modifiable: false, + phase: generic_template_phase_1}, + {title: "Ethics and Legal Compliance", + number: 3, + published: true, + modifiable: false, + phase: generic_template_phase_1}, + {title: "Storage and Backup", + number: 4, + published: true, + modifiable: false, + phase: generic_template_phase_1}, + {title: "Selection and Preservation", + number: 5, + published: true, + modifiable: false, + phase: generic_template_phase_1}, + {title: "Data Sharing", + number: 6, + published: true, + modifiable: false, + phase: generic_template_phase_1}, + {title: "Responsibilities and Resources", + number: 7, + published: true, + modifiable: false, + phase: generic_template_phase_1}, + + # Section of old version of Funder Template + {title: "Data Collection and Preservation", + number: 1, + published: false, + modifiable: true, + phase: Phase.find_by(title: "Detailed Overview")}, + + # Sections for the Funder Template's Preliminary Phase + {title: "Data Overview", + number: 1, + published: false, + modifiable: true, + phase: funder_template_phase_1}, + {title: "Data Description", + number: 1, + published: false, + modifiable: true, + phase: funder_template_phase_1}, + + # Sections for the Funder Template's Detailed Phase + {title: "Preservation Policy", + number: 1, + published: true, + modifiable: false, + phase: funder_template_phase_2}, + {title: "Data Format and Storage", + number: 1, + published: true, + modifiable: false, + phase: funder_template_phase_2}, + {title: "Collection Process", + number: 1, + published: true, + modifiable: false, + phase: funder_template_phase_2}, + {title: "Ethical Standards", + number: 1, + published: true, + modifiable: false, + phase: funder_template_phase_2}, + {title: "Preservation and Reuse Policies", + number: 1, + published: true, + modifiable: false, + phase: funder_template_phase_2} +] +sections.map{ |s| Section.create!(s) if Section.find_by(title: s[:title]).nil? } + +text_area = QuestionFormat.find_by(title: "Text area") + +# Create questions for the 2 templates and their phases +# ------------------------------------------------------- +questions = [ + # Questions for the Generic Template + {text: "What data will you collect or create?", + number: 1, + section: Section.find_by(title: "Data Collection"), + question_format: text_area, + modifiable: false, + themes: [Theme.find_by(title: "Data Description")]}, + {text: "How will the data be collected or created?", + number: 2, + section: Section.find_by(title: "Data Collection"), + question_format: text_area, + modifiable: false, + themes: [Theme.find_by(title: "Data Collection")]}, + {text: "What documentation and metadata will accompany the data?", + number: 1, + section: Section.find_by(title: "Documentation and Metadata"), + question_format: text_area, + modifiable: false, + themes: [Theme.find_by(title: "Metadata & Documentation")]}, + {text: "How will you manage any ethical issues?", + number: 1, + section: Section.find_by(title: "Ethics and Legal Compliance"), + question_format: text_area, + modifiable: false, + themes: [Theme.find_by(title: "Ethics & Privacy")]}, + {text: "How will you manage copyright and Intellectual Property Rights (IPR) issues?", + number: 2, + section: Section.find_by(title: "Ethics and Legal Compliance"), + question_format: text_area, + modifiable: false, + themes: [Theme.find_by(title: "Intellectual Property Rights")]}, + {text: "How will the data be stored and backed up during the research?", + number: 1, + section: Section.find_by(title: "Storage and Backup"), + question_format: text_area, + modifiable: false, + themes: [Theme.find_by(title: "Storage & Security")]}, + {text: "How will you manage access and security?", + number: 2, + section: Section.find_by(title: "Storage and Backup"), + question_format: text_area, + modifiable: false, + themes: [Theme.find_by(title: "Storage & Security")]}, + {text: "Which data are of long-term value and should be retained, shared, and/or preserved?", + number: 1, + section: Section.find_by(title: "Selection and Preservation"), + question_format: text_area, + modifiable: false, + themes: [Theme.find_by(title: "Preservation")]}, + {text: "What is the long-term preservation plan for the dataset?", + number: 2, + section: Section.find_by(title: "Selection and Preservation"), + question_format: text_area, + modifiable: false}, + {text: "How will you share the data?", + number: 1, + section: Section.find_by(title: "Data Sharing"), + question_format: text_area, + modifiable: false, + themes: [Theme.find_by(title: "Data Sharing")]}, + {text: "Are any restrictions on data sharing required?", + number: 2, + section: Section.find_by(title: "Data Sharing"), + question_format: text_area, + modifiable: false}, + {text: "Who will be responsible for data management?", + number: 1, + section: Section.find_by(title: "Responsibilities and Resources"), + question_format: text_area, + modifiable: false, + themes: [Theme.find_by(title: "Roles & Responsibilities")]}, + {text: "What resources will you require to deliver your plan?", + number: 2, + modifiable: false, + section: Section.find_by(title: "Responsibilities and Resources"), + question_format: text_area}, + + # Questions for old version of Funder Template + {text: "What data will you collect and how will it be obtained?", + number: 1, + modifiable: false, + section: Section.find_by(title: "Data Collection and Preservation"), + question_format: text_area}, + {text: "How will you preserve your data during the project and long-term?", + number: 2, + modifiable: false, + section: Section.find_by(title: "Data Collection and Preservation"), + question_format: text_area}, + + # Questions for the Funder Template's Preliminary Phase + {text: "Provide an overview of the dataset.", + number: 1, + section: Section.find_by(title: "Data Overview"), + question_format: text_area, + modifiable: true, + themes: [Theme.find_by(title: "Data Description")]}, + {text: "What types/formats of data will you collect?", + number: 1, + modifiable: true, + section: Section.find_by(title: "Data Description"), + question_format: text_area, + themes: [Theme.find_by(title: "Data Format")]}, + {text: "How will you store the data and how will it be preserved?", + number: 2, + modifiable: true, + section: Section.find_by(title: "Data Description"), + question_format: text_area, + themes: [Theme.find_by(title: "Data Collection")]}, + + # Questions for the Funder Template's Detailed Phase + {text: "What is your policy for long term access to your dataset?", + number: 1, + section: Section.find_by(title: "Preservation Policy"), + question_format: text_area, + modifiable: false, + default_value: "Please enter your answer here ..." , + themes: [Theme.find_by(title: "Preservation")]}, + {text: "Where will your data be preserved?", + number: 2, + section: Section.find_by(title: "Preservation Policy"), + question_format: QuestionFormat.find_by(title: "Text field"), + modifiable: false, + default_value: "on a server at my institution", + guidance: "Consider where your data will be stored after your research is complete.", + themes: [Theme.find_by(title: "Preservation")]}, + {text: "What types of data will you collect and how will it be stored?", + number: 1, + section: Section.find_by(title: "Data Format and Storage"), + question_format: text_area, + modifiable: false, + themes: [Theme.find_by(title: "Storage & Security"), Theme.find_by(title: 'Data Format')]}, + {text: "Please select the appropriate formats.", + number: 2, + section: Section.find_by(title: "Data Format and Storage"), + question_format: QuestionFormat.find_by(title: "Radio buttons"), + modifiable: false, + themes: [Theme.find_by(title: "Storage & Security"), Theme.find_by(title: 'Data Format')]}, + {text: "Will software accompany your dataset?", + number: 1, + section: Section.find_by(title: "Collection Process"), + question_format: QuestionFormat.find_by(title: "Check box"), + modifiable: false, + themes: [Theme.find_by(title: "Data Collection")]}, + {text: "Where will you store your data during the research period?", + number: 2, + section: Section.find_by(title: "Collection Process"), + question_format: QuestionFormat.find_by(title: "Dropdown"), + modifiable: false, + themes: [Theme.find_by(title: "Data Collection")]}, + {text: "What type(s) of data will you collect?", + number: 3, + section: Section.find_by(title: "Collection Process"), + question_format: QuestionFormat.find_by(title: "Multi select box"), + option_comment_display: true, + modifiable: false, + themes: [Theme.find_by(title: "Data Collection")]}, + {text: "What are your institution's ethical policies?", + number: 1, + section: Section.find_by(title: "Ethical Standards"), + question_format: text_area, + modifiable: false, + themes: [Theme.find_by(title: "Ethics & Privacy")]}, + {text: "When will your data be available for public consumption?", + number: 2, + section: Section.find_by(title: "Ethical Standards"), + question_format: QuestionFormat.find_by(title: "Date"), + modifiable: false, + themes: [Theme.find_by(title: "Ethics & Privacy")]}, + {text: "Tell us about your departmental and institutional policies on reuse and preservation.", + number: 1, + section: Section.find_by(title: "Preservation and Reuse Policies"), + question_format: text_area, + modifiable: false, + themes: [Theme.find_by(title: "Preservation"), Theme.find_by(title: "Data Sharing")]} +] +questions.map{ |q| Question.create!(q) if Question.find_by(text: q[:text]).nil? } + +drop_down_question = Question.find_by(text: "Where will you store your data during the research period?") +multi_select_question = Question.find_by(text: "What type(s) of data will you collect?") +radio_button_question = Question.find_by(text: "Please select the appropriate formats.") + +# Create suggested answers for a few questions +# ------------------------------------------------------- +suggested_answers = [ + {text: "We will preserve it in Dryad or a similar data repository service.", + is_example: true, + org: Org.find_by(abbreviation: 'GA'), + question: Question.find_by(text: "What is your policy for long term access to your dataset?")}, + {text: "We recommend that you identify the type(s) of content as well as the type of file(s) involved", + is_example: false, + org: Org.find_by(abbreviation: 'GA'), + question: Question.find_by(text: "What types of data will you collect and how will it be stored?")}, +] +suggested_answers.map{ |s| SuggestedAnswer.create!(s) if SuggestedAnswer.find_by(text: s[:text]).nil? } + +# Create options for the dropdown, multi-select and radio buttons +# ------------------------------------------------------- +question_options = [ + {text: "csv files", + number: 1, + question: radio_button_question, + is_default: false}, + {text: "database (e.g. mysql, redis)", + number: 2, + question: radio_button_question, + is_default: false}, + {text: "archive files (e.g. tar, zip)", + number: 3, + question: radio_button_question, + is_default: false}, + + {text: "local hard drive", + number: 1, + question: drop_down_question, + is_default: true}, + {text: "personal cloud storage", + number: 2, + question: drop_down_question, + is_default: false}, + {text: "institutional servers", + number: 3, + question: drop_down_question, + is_default: false}, + + {text: "statistical", + number: 1, + question: multi_select_question, + is_default: false}, + {text: "image/video", + number: 2, + question: multi_select_question, + is_default: false}, + {text: "geographical", + number: 3, + question: multi_select_question, + is_default: false}, + {text: "other", + number: 4, + question: multi_select_question, + is_default: false} +] +question_options.map{ |q| QuestionOption.create!(q) if QuestionOption.find_by(text: q[:text]).nil? } + +# Create plans +# ------------------------------------------------------- +=begin +plans = [ + {title: "Sample plan", + template: Template.find_by(title: "Department of Testing Award"), + grant_number: "FUNDER-GRANT-123", + identifier: "987654321", + description: "This is a sample plan based on a funder template", + principal_investigator: "John Doe", + principal_investigator_identifier: "ORCID: 12346-000-1234", + data_contact: "john.doe@example.com", + funder_name: "Example Government Agency", + visibility: 0} +] +plans.map{ |p| Plan.create!(p) if Plan.find_by(title: "Sample plan").nil? } + +plan = Plan.find_by(title: "Sample plan") +user = User.find_by(email: "org_user@example.com") + +answers = [ + {text: "We will collect data from various sources and create our own analysis.", + plan: plan, + user: user, + question: Question.find_by(text: "Provide an overview of the dataset.")}, + {text: "We will primarily collect images and video from our telescope and other instruments", + plan: plan, + user: user, + question: Question.find_by(text: "What types/formats of data will you collect?")}, + {text: "We will store the data on our departmental server and then move it to a commercial data repository afterward.", + plan: plan, + user: user, + question: Question.find_by(text: "How will you store the data and how will it be preserved?")}, + + {text: "We want people to be able to access it. ", + plan: plan, + user: user, + question: Question.find_by(text: "What is your policy for long term access to your dataset?")}, + {plan: plan, + user: user, + question: drop_down_question, + question_options: [QuestionOption.find_by(text: "institutional servers")]}, + {plan: plan, + user: user, + question: multi_select_question, + question_options: [QuestionOption.find_by(text: "image/video"), + QuestionOption.find_by(text: "other")]}, + {plan: plan, + user: user, + question: radio_button_question, + question_options: [QuestionOption.find_by(text: "archive files (e.g. tar, zip)"), + QuestionOption.find_by(text: "csv files")]}, + {text: "Yes", + plan: plan, + user: user, + question: Question.find_by(text: "Will software accompany your dataset?")}, + {text: "On a local server", + plan: plan, + user: user, + question: Question.find_by(text: "Where will you store your data during the research period?")}, + {text: "2018-05-01 00:00:01", + plan: plan, + user: user, + question: Question.find_by(text: "When will your data be available for public consumption?")} +] +answers.map{ |a| Answer.create!(a) if Answer.where(plan: a[:plan], user: a[:user], question: a[:question]).empty? } +=end \ No newline at end of file diff --git a/test/unit/dmptemplate_test.rb b/test/unit/dmptemplate_test.rb deleted file mode 100644 index c17a2ba..0000000 --- a/test/unit/dmptemplate_test.rb +++ /dev/null @@ -1,347 +0,0 @@ -require 'test_helper' - -class DmptemplateTest < ActiveSupport::TestCase - - setup do - @template = Dmptemplate.first - - @organisation = Organisation.first - end - - def settings(extras = {}) - {margin: (@margin || { top: 10, bottom: 10, left: 10, right: 10 }), - font_face: (@font_face || Settings::Dmptemplate::VALID_FONT_FACES.first), - font_size: (@font_size || 11) - }.merge(extras) - end - - def default_formatting - Settings::Dmptemplate::DEFAULT_SETTINGS[:formatting] - end - - # --------------------------------------------------- - test "required fields are required" do - assert_not Dmptemplate.new.valid? - assert_not Dmptemplate.new(title: 'Testing tmeplate').valid?, "expected the 'organisation' field to be required" - assert_not Dmptemplate.new(organisation: @organisation).valid?, "expected the 'title' field to be required" - - # Ensure the bar minimum and complete versions are valid - a = Dmptemplate.new(organisation: @organisation, title: 'Testing tmeplate') - assert a.valid?, "expected the 'title' and 'organisation' fields to be enough to create an Dmptemplate! - #{a.errors.map{|f, m| f.to_s + ' ' + m}.join(', ')}" - end - - # --------------------------------------------------- - test "to_s method returns the title" do - assert_equal @template.title, @template.to_s - end - - - # ---------- settings ---------- - # --------------------------------------------------- - test "settings should use defaults if none are defined" do - assert(!@template.settings(:export).value?) - assert_equal(default_formatting, @template.settings(:export).formatting) - end - - # --------------------------------------------------- - test "settings should use defined valid settings" do - @template.settings(:export).formatting = settings - @template.save! - - assert(@template.settings(:export).value?) - assert_equal(settings, @template.settings(:export).formatting) - assert_not_equal(default_formatting, @template.settings(:export).formatting) - end - - # --------------------------------------------------- - test "setting negative margin should not be valid" do - @margin = { top: -10, bottom: 10, left: 10, right: 10 } - - @template.settings(:export).formatting = settings - - assert(!@template.valid?) - assert(!@template.save) - - assert_equal(I18n.t('helpers.settings.plans.errors.negative_margin'), - @template.errors.messages[:'setting_objects.formatting'].first) - - @template.reload - assert_equal(default_formatting, @template.settings(:export).formatting) - end - - # --------------------------------------------------- - test "setting unknown margin should not be valid" do - @margin = { top: 10, bottom: 10, left: 10, right: 10, top_left: 10 } - - @template.settings(:export).formatting = settings - - assert(!@template.valid?) - assert(!@template.save) - - assert_equal(I18n.t('helpers.settings.plans.errors.unknown_margin'), - @template.errors.messages[:'setting_objects.formatting'].first) - - @template.reload - assert_equal(default_formatting, @template.settings(:export).formatting) - end - - # --------------------------------------------------- - test "setting negative font-size should not be valid" do - @font_size = -11 - - @template.settings(:export).formatting = settings - - assert(!@template.valid?) - assert(!@template.save) - - assert_equal(I18n.t('helpers.settings.plans.errors.invalid_font_size'), - @template.errors.messages[:'setting_objects.formatting'].first) - - @template.reload - - assert_equal(default_formatting, @template.settings(:export).formatting) - end - - # --------------------------------------------------- - test "setting unknown key should not be valid" do - @template.settings(:export).formatting = settings(foo: :bar) - - assert(!@template.valid?) - assert(!@template.save) - - assert_equal(I18n.t('helpers.settings.plans.errors.unknown_key'), - @template.errors.messages[:'setting_objects.formatting'].first) - - @template.reload - - assert_equal(default_formatting, @template.settings(:export).formatting) - end - - # --------------------------------------------------- - test "not setting font_face should not be valid" do - @template.settings(:export).formatting = settings.reject {|k,v| k == :font_face } - - assert(!@template.valid?) - assert(!@template.save) - - assert_equal(I18n.t('helpers.settings.plans.errors.missing_key'), - @template.errors.messages[:'setting_objects.formatting'].first) - - @template.reload - - assert_equal(default_formatting, @template.settings(:export).formatting) - end - - # --------------------------------------------------- - test "not setting font_size should not be valid" do - @template.settings(:export).formatting = settings.reject {|k,v| k == :font_size } - - assert(!@template.valid?) - assert(!@template.save) - - assert_equal(I18n.t('helpers.settings.plans.errors.missing_key'), - @template.errors.messages[:'setting_objects.formatting'].first) - - @template.reload - - assert_equal(default_formatting, @template.settings(:export).formatting) - end - - # --------------------------------------------------- - test "not setting margin should not be valid" do - @template.settings(:export).formatting = settings.reject {|k,v| k == :margin } - - assert(!@template.valid?) - assert(!@template.save) - - assert_equal(I18n.t('helpers.settings.plans.errors.missing_key'), - @template.errors.messages[:'setting_objects.formatting'].first) - - @template.reload - - assert_equal(default_formatting, @template.settings(:export).formatting) - end - - # --------------------------------------------------- - test "setting non-hash as margin should not be valid" do - @margin = :foo - - @template.settings(:export).formatting = settings - - assert(!@template.valid?) - assert(!@template.save) - - assert_equal(I18n.t('helpers.settings.plans.errors.invalid_margin'), - @template.errors.messages[:'setting_objects.formatting'].first) - - @template.reload - - assert_equal(default_formatting, @template.settings(:export).formatting) - end - - # --------------------------------------------------- - test "setting non-integer as font_size should not be valid" do - @font_size = "foo" - - @template.settings(:export).formatting = settings - - assert(!@template.valid?) - assert(!@template.save) - - assert_equal(I18n.t('helpers.settings.plans.errors.invalid_font_size'), - @template.errors.messages[:'setting_objects.formatting'].first) - - @template.reload - - assert_equal(default_formatting, @template.settings(:export).formatting) - end - - # --------------------------------------------------- - test "setting non-string as font_face should not be valid" do - @font_face = 1 - - @template.settings(:export).formatting = settings - - assert(!@template.valid?) - assert(!@template.save) - - assert_equal(I18n.t('helpers.settings.plans.errors.invalid_font_face'), - @template.errors.messages[:'setting_objects.formatting'].first) - - @template.reload - - assert_equal(default_formatting, @template.settings(:export).formatting) - end - - # --------------------------------------------------- - test "setting unknown string as font_face should not be valid" do - @font_face = 'Monaco, Monospace, Sans-Serif' - - @template.settings(:export).formatting = settings - - assert(!@template.valid?) - assert(!@template.save) - - assert_equal(I18n.t('helpers.settings.plans.errors.invalid_font_face'), - @template.errors.messages[:'setting_objects.formatting'].first) - - @template.reload - - assert_equal(default_formatting, @template.settings(:export).formatting) - end - -<<<<<<< HEAD -======= - # ---------- templates_org_type ---------- - test "templates_org_type returns all published" do - OrganisationType.find_each do |org_type| - result_templates = Dmptemplate.templates_org_type(org_type.name) - my_list = Array.new - org_type.organisations.each do |org| - my_list += org.dmptemplates - end - my_list.each do |template| - if template.published - assert_includes(result_templates, template, "Template: #{template.title}} of type #{org_type.name}, not returned by templates_org_type") - end - end - end - end - - # ---------- funders_templates ---------- - test "funders_templates returns all funder organisation templates" do - result_templates = Dmptemplate.funders_templates - funder_templates = OrganisationType.first.organisations do |org| - org.dmptemplates.each do |template| - assert_includes( result_templates, template, "Funder Template: #{template.title} not included in result of funders_templates") - end - end - end - - # ---------- own_institutional_templates ---------- - test "own_institutional_templates returns all templates belonging to given org_id" do - Org.find_each do |org| - result_templates = Dmptemplate.own_institutional_templates(org.id) - org.dmptemplates.each do |template| - assert_includes(result_templates, template, "Template: #{template.title} not returned by own_institutional_templates") - end - end - end - - # ---------- funders_and_own_templates ---------- - test "funders_and_own_templates returns all funder and own given org_id templates" do - Org.find_each do |org| - result_templates = Dmptemplate.funders_and_own_templates(org.id) - org.dmptemplates.each do |template| - assert_includes(result_templates, template, "Template #{template.title} not returned by funders and own templates") - end - end - funder_templates = OrganisationType.first.organisations do |org| - org.dmptemplates.each do |template| - assert_includes( result_templates, template, "Funder Template: #{template.title} not included in result of funders_and_own_templates") - end - end - end - - # ---------- org_type ---------- - test "org_type properly returns the name of the template's organisation's type" do - Dmptemplate.find_each do |template| - assert_equal( template.org_type, template.organisation.organisation_type.name, "Template: #{template.title} returned #{template.org_type}, instead of #{template.organisation.organisation_type.name}") - end - end - ->>>>>>> final_schema - # ---------- has_customisations? ---------- - test "has_customisations? correctly identifies if a given org has customised the template" do - # TODO: Impliment after understanding has_customisations - - end - - # ---------- has_published_versions? ---------- - test "has_published_versions? correctly identifies published versions" do - Dmptemplate.find_each do |template| - template.phases.each do |phase| - unless phase.latest_published_version.nil? - assert(template.has_published_versions? , "there was a published version of phase: #{phase.title}") - end - end - end - end - - # --------------------------------------------------- - test "can CRUD Template" do - tmplt = Dmptemplate.create(organisation: @organisation, title: 'Testing tmeplate') - assert_not tmplt.id.nil?, "was expecting to be able to create a new Dmptemplate!" - - tmplt.description = 'Testing an update' - tmplt.save! - tmplt.reload - assert_equal 'Testing an update', tmplt.description, "Was expecting to be able to update the description of the Dmptemplate!" - - assert tmplt.destroy!, "Was unable to delete the Dmptemplate!" - end - - # --------------------------------------------------- - test "can manage has_many relationship with Phase" do - phase = Phase.new(title: 'Test Phase', number: 2) - verify_has_many_relationship(@template, phase, @template.phases.count) - end - - # --------------------------------------------------- - test "can manage has_many relationship with Project" do - project = Project.new(title: 'Test Project', organisation: @organisation) - verify_has_many_relationship(@template, project, @template.projects.count) - end - - # --------------------------------------------------- - test "can manage has_many relationship with GuidanceGroup" do - grp = GuidanceGroup.new(name: 'Test Group', organisation: @organisation) - verify_has_many_relationship(@template, grp, @template.guidance_groups.count) - end - - # --------------------------------------------------- - test "can manage belongs_to relationship with Organisation" do - verify_belongs_to_relationship(@template, @organisation) - end - -end diff --git a/test/unit/template_test.rb b/test/unit/template_test.rb new file mode 100644 index 0000000..0db44c4 --- /dev/null +++ b/test/unit/template_test.rb @@ -0,0 +1,347 @@ +require 'test_helper' + +class TemplateTest < ActiveSupport::TestCase + + setup do + @template = Dmptemplate.first + + @organisation = Organisation.first + end + + def settings(extras = {}) + {margin: (@margin || { top: 10, bottom: 10, left: 10, right: 10 }), + font_face: (@font_face || Settings::Dmptemplate::VALID_FONT_FACES.first), + font_size: (@font_size || 11) + }.merge(extras) + end + + def default_formatting + Settings::Dmptemplate::DEFAULT_SETTINGS[:formatting] + end + + # --------------------------------------------------- + test "required fields are required" do + assert_not Dmptemplate.new.valid? + assert_not Dmptemplate.new(title: 'Testing tmeplate').valid?, "expected the 'organisation' field to be required" + assert_not Dmptemplate.new(organisation: @organisation).valid?, "expected the 'title' field to be required" + + # Ensure the bar minimum and complete versions are valid + a = Dmptemplate.new(organisation: @organisation, title: 'Testing tmeplate') + assert a.valid?, "expected the 'title' and 'organisation' fields to be enough to create an Dmptemplate! - #{a.errors.map{|f, m| f.to_s + ' ' + m}.join(', ')}" + end + + # --------------------------------------------------- + test "to_s method returns the title" do + assert_equal @template.title, @template.to_s + end + + + # ---------- settings ---------- + # --------------------------------------------------- + test "settings should use defaults if none are defined" do + assert(!@template.settings(:export).value?) + assert_equal(default_formatting, @template.settings(:export).formatting) + end + + # --------------------------------------------------- + test "settings should use defined valid settings" do + @template.settings(:export).formatting = settings + @template.save! + + assert(@template.settings(:export).value?) + assert_equal(settings, @template.settings(:export).formatting) + assert_not_equal(default_formatting, @template.settings(:export).formatting) + end + + # --------------------------------------------------- + test "setting negative margin should not be valid" do + @margin = { top: -10, bottom: 10, left: 10, right: 10 } + + @template.settings(:export).formatting = settings + + assert(!@template.valid?) + assert(!@template.save) + + assert_equal(I18n.t('helpers.settings.plans.errors.negative_margin'), + @template.errors.messages[:'setting_objects.formatting'].first) + + @template.reload + assert_equal(default_formatting, @template.settings(:export).formatting) + end + + # --------------------------------------------------- + test "setting unknown margin should not be valid" do + @margin = { top: 10, bottom: 10, left: 10, right: 10, top_left: 10 } + + @template.settings(:export).formatting = settings + + assert(!@template.valid?) + assert(!@template.save) + + assert_equal(I18n.t('helpers.settings.plans.errors.unknown_margin'), + @template.errors.messages[:'setting_objects.formatting'].first) + + @template.reload + assert_equal(default_formatting, @template.settings(:export).formatting) + end + + # --------------------------------------------------- + test "setting negative font-size should not be valid" do + @font_size = -11 + + @template.settings(:export).formatting = settings + + assert(!@template.valid?) + assert(!@template.save) + + assert_equal(I18n.t('helpers.settings.plans.errors.invalid_font_size'), + @template.errors.messages[:'setting_objects.formatting'].first) + + @template.reload + + assert_equal(default_formatting, @template.settings(:export).formatting) + end + + # --------------------------------------------------- + test "setting unknown key should not be valid" do + @template.settings(:export).formatting = settings(foo: :bar) + + assert(!@template.valid?) + assert(!@template.save) + + assert_equal(I18n.t('helpers.settings.plans.errors.unknown_key'), + @template.errors.messages[:'setting_objects.formatting'].first) + + @template.reload + + assert_equal(default_formatting, @template.settings(:export).formatting) + end + + # --------------------------------------------------- + test "not setting font_face should not be valid" do + @template.settings(:export).formatting = settings.reject {|k,v| k == :font_face } + + assert(!@template.valid?) + assert(!@template.save) + + assert_equal(I18n.t('helpers.settings.plans.errors.missing_key'), + @template.errors.messages[:'setting_objects.formatting'].first) + + @template.reload + + assert_equal(default_formatting, @template.settings(:export).formatting) + end + + # --------------------------------------------------- + test "not setting font_size should not be valid" do + @template.settings(:export).formatting = settings.reject {|k,v| k == :font_size } + + assert(!@template.valid?) + assert(!@template.save) + + assert_equal(I18n.t('helpers.settings.plans.errors.missing_key'), + @template.errors.messages[:'setting_objects.formatting'].first) + + @template.reload + + assert_equal(default_formatting, @template.settings(:export).formatting) + end + + # --------------------------------------------------- + test "not setting margin should not be valid" do + @template.settings(:export).formatting = settings.reject {|k,v| k == :margin } + + assert(!@template.valid?) + assert(!@template.save) + + assert_equal(I18n.t('helpers.settings.plans.errors.missing_key'), + @template.errors.messages[:'setting_objects.formatting'].first) + + @template.reload + + assert_equal(default_formatting, @template.settings(:export).formatting) + end + + # --------------------------------------------------- + test "setting non-hash as margin should not be valid" do + @margin = :foo + + @template.settings(:export).formatting = settings + + assert(!@template.valid?) + assert(!@template.save) + + assert_equal(I18n.t('helpers.settings.plans.errors.invalid_margin'), + @template.errors.messages[:'setting_objects.formatting'].first) + + @template.reload + + assert_equal(default_formatting, @template.settings(:export).formatting) + end + + # --------------------------------------------------- + test "setting non-integer as font_size should not be valid" do + @font_size = "foo" + + @template.settings(:export).formatting = settings + + assert(!@template.valid?) + assert(!@template.save) + + assert_equal(I18n.t('helpers.settings.plans.errors.invalid_font_size'), + @template.errors.messages[:'setting_objects.formatting'].first) + + @template.reload + + assert_equal(default_formatting, @template.settings(:export).formatting) + end + + # --------------------------------------------------- + test "setting non-string as font_face should not be valid" do + @font_face = 1 + + @template.settings(:export).formatting = settings + + assert(!@template.valid?) + assert(!@template.save) + + assert_equal(I18n.t('helpers.settings.plans.errors.invalid_font_face'), + @template.errors.messages[:'setting_objects.formatting'].first) + + @template.reload + + assert_equal(default_formatting, @template.settings(:export).formatting) + end + + # --------------------------------------------------- + test "setting unknown string as font_face should not be valid" do + @font_face = 'Monaco, Monospace, Sans-Serif' + + @template.settings(:export).formatting = settings + + assert(!@template.valid?) + assert(!@template.save) + + assert_equal(I18n.t('helpers.settings.plans.errors.invalid_font_face'), + @template.errors.messages[:'setting_objects.formatting'].first) + + @template.reload + + assert_equal(default_formatting, @template.settings(:export).formatting) + end + +<<<<<<< HEAD +======= + # ---------- templates_org_type ---------- + test "templates_org_type returns all published" do + OrganisationType.find_each do |org_type| + result_templates = Dmptemplate.templates_org_type(org_type.name) + my_list = Array.new + org_type.organisations.each do |org| + my_list += org.dmptemplates + end + my_list.each do |template| + if template.published + assert_includes(result_templates, template, "Template: #{template.title}} of type #{org_type.name}, not returned by templates_org_type") + end + end + end + end + + # ---------- funders_templates ---------- + test "funders_templates returns all funder organisation templates" do + result_templates = Dmptemplate.funders_templates + funder_templates = OrganisationType.first.organisations do |org| + org.dmptemplates.each do |template| + assert_includes( result_templates, template, "Funder Template: #{template.title} not included in result of funders_templates") + end + end + end + + # ---------- own_institutional_templates ---------- + test "own_institutional_templates returns all templates belonging to given org_id" do + Org.find_each do |org| + result_templates = Dmptemplate.own_institutional_templates(org.id) + org.dmptemplates.each do |template| + assert_includes(result_templates, template, "Template: #{template.title} not returned by own_institutional_templates") + end + end + end + + # ---------- funders_and_own_templates ---------- + test "funders_and_own_templates returns all funder and own given org_id templates" do + Org.find_each do |org| + result_templates = Dmptemplate.funders_and_own_templates(org.id) + org.dmptemplates.each do |template| + assert_includes(result_templates, template, "Template #{template.title} not returned by funders and own templates") + end + end + funder_templates = OrganisationType.first.organisations do |org| + org.dmptemplates.each do |template| + assert_includes( result_templates, template, "Funder Template: #{template.title} not included in result of funders_and_own_templates") + end + end + end + + # ---------- org_type ---------- + test "org_type properly returns the name of the template's organisation's type" do + Dmptemplate.find_each do |template| + assert_equal( template.org_type, template.organisation.organisation_type.name, "Template: #{template.title} returned #{template.org_type}, instead of #{template.organisation.organisation_type.name}") + end + end + +>>>>>>> final_schema + # ---------- has_customisations? ---------- + test "has_customisations? correctly identifies if a given org has customised the template" do + # TODO: Impliment after understanding has_customisations + + end + + # ---------- has_published_versions? ---------- + test "has_published_versions? correctly identifies published versions" do + Dmptemplate.find_each do |template| + template.phases.each do |phase| + unless phase.latest_published_version.nil? + assert(template.has_published_versions? , "there was a published version of phase: #{phase.title}") + end + end + end + end + + # --------------------------------------------------- + test "can CRUD Template" do + tmplt = Dmptemplate.create(organisation: @organisation, title: 'Testing tmeplate') + assert_not tmplt.id.nil?, "was expecting to be able to create a new Dmptemplate!" + + tmplt.description = 'Testing an update' + tmplt.save! + tmplt.reload + assert_equal 'Testing an update', tmplt.description, "Was expecting to be able to update the description of the Dmptemplate!" + + assert tmplt.destroy!, "Was unable to delete the Dmptemplate!" + end + + # --------------------------------------------------- + test "can manage has_many relationship with Phase" do + phase = Phase.new(title: 'Test Phase', number: 2) + verify_has_many_relationship(@template, phase, @template.phases.count) + end + + # --------------------------------------------------- + test "can manage has_many relationship with Project" do + project = Project.new(title: 'Test Project', organisation: @organisation) + verify_has_many_relationship(@template, project, @template.projects.count) + end + + # --------------------------------------------------- + test "can manage has_many relationship with GuidanceGroup" do + grp = GuidanceGroup.new(name: 'Test Group', organisation: @organisation) + verify_has_many_relationship(@template, grp, @template.guidance_groups.count) + end + + # --------------------------------------------------- + test "can manage belongs_to relationship with Organisation" do + verify_belongs_to_relationship(@template, @organisation) + end + +end