malawi_hiv_program_reports 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 5f9bdb524dbe6d3e2764ab2faf53333e01bb7177ffc2b36c8e61e9d5a3dccb74
4
+ data.tar.gz: a31c8be69459537dad89df2a00436aed37b7c89876f178e89986bb132f1c48d6
5
+ SHA512:
6
+ metadata.gz: e6ce784facefd7deb10871c70ce705aecdac364469e9de43b559493ecc5960690a84484b2bf31ee6758c56663af4c05dc562838640fabecdd75c51d683731779
7
+ data.tar.gz: ea99c9552a36fbd70a660d39ce4f9bd0a5745433ee8dac403ed47afb1eb0b080542b88b188ef64ba0450edfa0af6acacb61c16f263976dc2e526e4995a68bfdb
@@ -0,0 +1,46 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
6
+
7
+ ## Our Standards
8
+
9
+ Examples of behavior that contributes to creating a positive environment include:
10
+
11
+ * Using welcoming and inclusive language
12
+ * Being respectful of differing viewpoints and experiences
13
+ * Gracefully accepting constructive criticism
14
+ * Focusing on what is best for the community
15
+ * Showing empathy towards other community members
16
+
17
+ Examples of unacceptable behavior by participants include:
18
+
19
+ * The use of sexualized language or imagery and unwelcome sexual attention or advances
20
+ * Trolling, insulting/derogatory comments, and personal or political attacks
21
+ * Public or private harassment
22
+ * Publishing others' private information, such as a physical or electronic address, without explicit permission
23
+ * Other conduct which could reasonably be considered inappropriate in a professional setting
24
+
25
+ ## Our Responsibilities
26
+
27
+ Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
28
+
29
+ Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
30
+
31
+ ## Scope
32
+
33
+ This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
34
+
35
+ ## Enforcement
36
+
37
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at info@pedaids.org. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
38
+
39
+ Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
40
+
41
+ ## Attribution
42
+
43
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
44
+
45
+ [homepage]: http://contributor-covenant.org
46
+ [version]: http://contributor-covenant.org/version/1/4/
@@ -0,0 +1,14 @@
1
+ # Contributing
2
+
3
+ 1. [Fork the repository.][fork]
4
+ 2. [Create a topic branch.][branch]
5
+ 3. Implement your feature or bug fix.
6
+ 4. Don't forget to add specs and make sure they pass by running `rspec .`.
7
+ 5. Make sure your code complies with the style guide by running `rubocop`. `rubocop -a` can automatically fix most issues for you.
8
+ 6. If necessary, add documentation for your feature or bug fix.
9
+ 7. Commit and push your changes.
10
+ 8. [Submit a pull request.][pr]
11
+
12
+ [fork]: http://help.github.com/fork-a-repo/
13
+ [branch]: https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-branches
14
+ [pr]: https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests
@@ -0,0 +1,20 @@
1
+ ## Context
2
+ *Gives the reviewer some context about the work and why this change is being made, the WHY you are doing this. This field goes more into the product perspective.*
3
+
4
+ ## Description
5
+ *Provide a detailed description of how exactly this task will be accomplished. This can be something technical. What specific steps will be taken to achieve the goal? This should include details on service integration, job logic, implementation, etc.*
6
+
7
+ ## Changes in the codebase
8
+ *This is where becomes technical. Here is where you can be more focused on the engineering side of your solution. Include information about the functionality they are adding or modifying, as well as any refactoring or improvement of existing code.*
9
+
10
+ ## Changes outside the codebase
11
+ *If you have made changes to external services, need to add additional values to the job settings, or need to add something new to the database, explain it here. This may include updates to third-party services, changes to infrastructure configuration, integration with external APIs, etc.*
12
+
13
+ ## Aditional information
14
+ *Provide any additional information that might be useful to the reviewer in evaluating this pull request. This could include performance considerations,design choices, etc.*
15
+
16
+ ## Ticket
17
+ *Link to the ticket that this PR is related to. This is important to keep track of the work and to have a reference to the context of the work.*
18
+
19
+ ## Screenshots
20
+ *If the change is visual, include screenshots or gifs of the changes. This can be useful for the reviewer to understand the changes and to see if the changes are as expected.*
data/CHANGELOG.md ADDED
@@ -0,0 +1,58 @@
1
+ # Changelog
2
+
3
+ All notable changes to this project will be documented in this file.
4
+
5
+ # Template
6
+ The new version number should be in the format `X.Y.Z` and the date should be in the format `YYYY-MM-DD`. Should be in reverse chronological order.
7
+ ```markdown
8
+
9
+ ## [Unreleased]
10
+
11
+ ### Added
12
+
13
+ - [Feature 1]: Description of the feature or enhancement.
14
+ - [Feature 2]: Description of the feature or enhancement.
15
+
16
+ ### Changed
17
+
18
+ - [Feature 1]: Description of the change or improvement.
19
+ - [Feature 2]: Description of the change or improvement.
20
+
21
+ ### Deprecated
22
+
23
+ - [Feature 1]: Description of the deprecated feature or functionality.
24
+
25
+ ### Removed
26
+
27
+ - [Feature 1]: Description of the removed feature or functionality.
28
+
29
+ ### Fixed
30
+
31
+ - [Bug 1]: Description of the bug fix.
32
+ - [Bug 2]: Description of the bug fix.
33
+ ```
34
+
35
+ ## [Version 1.0.0] - 2024-03-01
36
+
37
+ ### Added
38
+
39
+ - [Feature 1]: Description of the feature or enhancement.
40
+ - [Feature 2]: Description of the feature or enhancement.
41
+
42
+ ### Changed
43
+
44
+ - [Feature 1]: Description of the change or improvement.
45
+ - [Feature 2]: Description of the change or improvement.
46
+
47
+ ### Deprecated
48
+
49
+ - [Feature 1]: Description of the deprecated feature or functionality.
50
+
51
+ ### Removed
52
+
53
+ - [Feature 1]: Description of the removed feature or functionality.
54
+
55
+ ### Fixed
56
+
57
+ - [Bug 1]: Description of the bug fix.
58
+ - [Bug 2]: Description of the bug fix.
data/Gemfile ADDED
@@ -0,0 +1,5 @@
1
+ # frozen_string_literal: true
2
+
3
+ source 'https://rubygems.org'
4
+
5
+ gemspec
data/MIT-LICENSE ADDED
@@ -0,0 +1,20 @@
1
+ Copyright 2024 Roy Chanunkha
2
+
3
+ Permission is hereby granted, free of charge, to any person obtaining
4
+ a copy of this software and associated documentation files (the
5
+ "Software"), to deal in the Software without restriction, including
6
+ without limitation the rights to use, copy, modify, merge, publish,
7
+ distribute, sublicense, and/or sell copies of the Software, and to
8
+ permit persons to whom the Software is furnished to do so, subject to
9
+ the following conditions:
10
+
11
+ The above copyright notice and this permission notice shall be
12
+ included in all copies or substantial portions of the Software.
13
+
14
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
17
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
18
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
19
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
20
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,68 @@
1
+ # Malawi HIV PROGRAM Reports
2
+
3
+ [![Gem Version](https://badge.fury.io/rb/your_gem_name.svg)](https://badge.fury.io/rb/your_gem_name)
4
+ [![Build Status](https://travis-ci.org/your_username/your_gem_name.svg?branch=master)](https://travis-ci.org/your_username/your_gem_name)
5
+ [![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT)
6
+
7
+ ## Description
8
+
9
+ This gem provides a simple way to generate reports for the Malawi HIV PROGRAM. It is designed to be used by the Ministry of Health and other stakeholders to generate reports for the program. The reports depend on OpenMRS data and are generated in a format that is easy to understand and use.
10
+
11
+ ## Installation
12
+
13
+ Add this line to your application's Gemfile:
14
+
15
+ ```ruby
16
+ gem 'malaria_hiv_program_reports'
17
+ ```
18
+
19
+ And then execute:
20
+
21
+ $ bundle
22
+
23
+ Or install it yourself as:
24
+
25
+ $ gem install malaria_hiv_program_reports
26
+
27
+ ## Usage
28
+ Since it is just a library, you can use it in your application to generate reports. Here is an example of how to use it:
29
+
30
+ ```ruby
31
+ MalariaHivProgramReports::Moh::Cohort::Report.new(start_date, end_date, location_id)
32
+ ```
33
+
34
+ ## Available Reports
35
+ The following reports are available in the system:
36
+ [Reports](app/README.md)
37
+
38
+ ## Development
39
+ To begin contributing code, after you have cloned this repo. Run the following command
40
+
41
+ $ bin/setup.sh
42
+
43
+ We recommend using Rubocop to ensure that your code is clean and easy to read. You can run Rubocop by running the following command:
44
+
45
+ $ rubocop
46
+
47
+ To run the tests, you can run the following command:
48
+
49
+ $ rspec
50
+
51
+ To install dependencies, you can run the following command:
52
+
53
+ $ bundle i
54
+
55
+ To check for outdated dependencies, you can run the following command:
56
+
57
+ $ bundle out
58
+
59
+ To update dependencies, you can run the following command:
60
+
61
+ $ bundle u
62
+
63
+
64
+ ## Contributing
65
+ Bug reports and pull requests are welcome on GitHub.
66
+
67
+ ## License
68
+ The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
data/Rakefile ADDED
@@ -0,0 +1,9 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'rake'
4
+ require 'rubocop/rake_task'
5
+
6
+ RuboCop::RakeTask.new do |task|
7
+ task.requires << 'rubocop-performance'
8
+ task.requires << 'rubocop-rspec'
9
+ end
@@ -0,0 +1,12 @@
1
+ # frozen_string_literal: true
2
+
3
+ module MalawiHivProgramReports
4
+ class Engine < ::Rails::Engine
5
+ isolate_namespace MalawiHivProgramReports
6
+ config.generators.api_only = true
7
+
8
+ config.generators do |g|
9
+ g.test_framework :rspec
10
+ end
11
+ end
12
+ end
@@ -0,0 +1,5 @@
1
+ # frozen_string_literal: true
2
+
3
+ module MalawiHivProgramReports
4
+ VERSION = '1.0.0'
5
+ end
@@ -0,0 +1,12 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Path: lib/malawi_hiv_program_reports.rb
4
+ require 'malawi_hiv_program_reports/version'
5
+ require 'malawi_hiv_program_reports/engine'
6
+
7
+ # Main module for the gem
8
+ module MalawiHivProgramReports
9
+ def self.hi
10
+ puts 'Welcome to MalawiHivProgramReports!'
11
+ end
12
+ end
metadata ADDED
@@ -0,0 +1,115 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: malawi_hiv_program_reports
3
+ version: !ruby/object:Gem::Version
4
+ version: 1.0.0
5
+ platform: ruby
6
+ authors:
7
+ - Roy Chanunkha
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2024-03-18 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: rails
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - ">="
18
+ - !ruby/object:Gem::Version
19
+ version: 7.0.6
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - ">="
25
+ - !ruby/object:Gem::Version
26
+ version: 7.0.6
27
+ - !ruby/object:Gem::Dependency
28
+ name: activerecord
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: 7.0.8
34
+ type: :runtime
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: 7.0.8
41
+ - !ruby/object:Gem::Dependency
42
+ name: rspec
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '3.13'
48
+ type: :runtime
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '3.13'
55
+ - !ruby/object:Gem::Dependency
56
+ name: mysql2
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: 0.5.6
62
+ type: :runtime
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: 0.5.6
69
+ description: |-
70
+ Malawi HIV PROGRAM Reports for Ruby on ::Rails. This can be used by both the EMR API
71
+ or the CDR platform
72
+ email:
73
+ - roychanunkha@gmail.com
74
+ executables: []
75
+ extensions: []
76
+ extra_rdoc_files:
77
+ - README.md
78
+ files:
79
+ - ".github/CODE_OF_CONDUCT.md"
80
+ - ".github/CONTRIBUTING.md"
81
+ - ".github/PULL_REQUEST_TEMPLATE.md"
82
+ - CHANGELOG.md
83
+ - Gemfile
84
+ - MIT-LICENSE
85
+ - README.md
86
+ - Rakefile
87
+ - lib/malawi_hiv_program_reports.rb
88
+ - lib/malawi_hiv_program_reports/engine.rb
89
+ - lib/malawi_hiv_program_reports/version.rb
90
+ homepage: https://github.com/EGPAFMalawiHIS/malawi_hiv_program_reports
91
+ licenses:
92
+ - MIT
93
+ metadata:
94
+ source_code_uri: https://github.com/EGPAFMalawiHIS/malawi_hiv_program_reports
95
+ rubygems_mfa_required: 'true'
96
+ post_install_message:
97
+ rdoc_options: []
98
+ require_paths:
99
+ - lib
100
+ required_ruby_version: !ruby/object:Gem::Requirement
101
+ requirements:
102
+ - - ">="
103
+ - !ruby/object:Gem::Version
104
+ version: 3.2.0
105
+ required_rubygems_version: !ruby/object:Gem::Requirement
106
+ requirements:
107
+ - - ">="
108
+ - !ruby/object:Gem::Version
109
+ version: '0'
110
+ requirements: []
111
+ rubygems_version: 3.5.6
112
+ signing_key:
113
+ specification_version: 4
114
+ summary: Malawi HIV PROGRAM Reports for Ruby on Rails
115
+ test_files: []