csp-resolver 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8b89688ec5b6907524a3b31a8159a7c78dbe61578ed77e47ddeddfb956777d4
-  data.tar.gz: 2791072bb632b2a19151ba5bd60c2ecbdb2923edfd727a0e3ccb6c1f30546ecb
+  metadata.gz: b2132843b5897c1dc72b0fd25d79d7a397c12346cb43aa8a7207eb2d3811dbba
+  data.tar.gz: b09b982f678d54011f2a32c6418a169391378f5e86bdd739f6a566f2fc8c0156
 SHA512:
-  metadata.gz: 0ec7e93632f200c4ffc71d702146acfc64e3395c8a77c987f0190dd64f6f2b377d858e3f8cbbb2341b70d8476ce86719a853359d043546eb0e7a8df374a73bf8
-  data.tar.gz: a0f7552bd93a53f387052eeba3b8a3cb411671d362e0bbb1524b41d176acd0d842d29d4e1be08e847d3c6b2e33dc5588dedebb1de2932018f57bb3a97b9d4a33
+  metadata.gz: e4c576c37e8ac70a1b21ca373bb2a5a3ac501703a4832638c90ed6ba62aa8af80c8016fe80d1db204fe68379adb762bff51be223def53d5fce11169c32079aae
+  data.tar.gz: 79992f4d8021a57b6cf2390a1c998d53f6b8478468799a16d3f1c7b921db3a3190cecd09a18d4fb33e0a8f599bd8ecffab2db4e814df7f9d1bcc95bea01625f7

data/.rubocop.yml

@@ -25,4 +25,6 @@ Style/ObjectThen:
   EnforcedStyle: yield_self
 Naming/FileName:
   Exclude:
-    - 'lib/csp-resolver.rb'
+    - 'lib/csp-resolver.rb'
+Gemspec/RequireMFA:
+  Enabled: false

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,133 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders 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, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+devs@rebase.com.br.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations
+

data/CONTRIBUTING.md

@@ -0,0 +1,72 @@
+# Contributing
+
+Thank you for your interest in contributing! We welcome contributions of all kinds, including new features, bug fixes, and documentation improvements.
+
+Please take a moment to review this document to make the contribution process easy and effective for everyone involved.
+
+If you have any questions, feel free to reach out by opening an issue or contacting the maintainers directly.
+
+## Table of Contents
+1. [How to Report an Issue](#how-to-report-an-issue)
+2. [Submitting a Pull Request](#submitting-a-pull-request)
+3. [Coding Guidelines](#coding-guidelines)
+4. [Code of Conduct](#code-of-conduct)
+
+## How to Report an Issue
+
+If you encounter any bugs or have feature requests, please create an issue on our GitHub repository.
+
+1. Go to the [Issues](https://github.com/Rebase-BR/csp-resolver/issues) page.
+2. Click on "New Issue".
+3. Select the "Bug report" or "Feature request".
+4. Fill in the details as prompted by the template.
+
+If your issue does not fit the provided templates, feel free to create an issue without following them. Provide as much detail as possible to help us understand and address your concern.
+
+## Submitting a Pull Request
+To submit a pull request, please follow these steps:
+
+1. **Fork the Repository**:
+    - Navigate to the [repository](https://github.com/Rebase-BR/csp-resolver).
+    - Click the "Fork" button in the top-right corner.
+2. **Clone the Forked Repository**:
+    ```sh
+    git clone https://github.com/Rebase-BR/csp-resolver.git
+    cd csp-resolver
+    ```
+3. **Create a Branch**:
+    ```sh
+    git checkout -b <your-branch-name>
+    ```
+4. **Make Your Changes**:
+    - Implement your feature, bug fix, or documentation improvement.
+    - If you're making changes to the code, write some tests.
+    - Ensure your code follows our [Coding Guidelines](#coding-guidelines).
+5. **Commit Your Changes**:
+    ```sh
+    git add .
+    git commit -m "Description of your changes"
+    ```
+6. **Push to Your Fork**:
+    ```sh
+    git push origin your-branch-name
+    ```
+7. **Create a Pull Request**:
+    - Go to your fork on GitHub.
+    - Click on the "Compare & pull request" button.
+    - Fill in the details of your pull request and submit.
+
+We will review your pull request and provide feedback. Please be responsive to our comments and make the necessary adjustments.
+
+## Coding Guidelines
+
+To ensure consistency and maintainability of the codebase, please adhere to the following guidelines:
+
+- Follow the Ruby community's [style guide](https://rubystyle.guide/).
+- Write tests for your changes.
+- Ensure all tests pass before submitting a pull request.
+- Document public methods and classes.
+
+## Code of Conduct
+
+By participating in this project, you agree to abide by our [Code of Conduct](./CODE_OF_CONDUCT.md). Please be respectful and considerate in all interactions.

data/README.md

@@ -256,5 +256,11 @@ problem.solve
 # => { 'A' => 'green', 'B' => 'red', 'C' => 'purple' }
 ```
 
+## Contributing
+See our [CONTRIBUTING](./CONTRIBUTING.md) guidelines.
+
+## Code of Conduct
+We expect that everyone participating in any way with this project follows our [Code of Conduct](./CODE_OF_CONDUCT.md).
+
 ## License
 This project is licensed under the [MIT License](MIT-LICENSE).

data/Rakefile

@@ -1,4 +1,16 @@
 # frozen_string_literal: true
 
 require 'bundler/gem_tasks'
-task default: %i[]
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+  t.verbose = false
+end
+
+RuboCop::RakeTask.new(:rubocop) do |t|
+  t.options = ['--format', 'simple']
+end
+
+task default: :spec

data/csp-resolver.gemspec

@@ -28,4 +28,7 @@ Gem::Specification.new do |spec|
   spec.bindir = 'exe'
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
 end

data/lib/csp/problem.rb

@@ -64,14 +64,17 @@ module CSP
 
     def add_ordering(ordering_algorithm)
       @ordering_algorithm = ordering_algorithm
+      self
     end
 
     def add_filtering(filtering_algorithm)
       @filtering_algorithm = filtering_algorithm
+      self
     end
 
     def add_lookahead(lookahead_algorithm)
       @lookahead_algorithm = lookahead_algorithm
+      self
     end
 
     private

data/lib/csp/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CSP
-  VERSION = '0.0.1'
+  VERSION = '0.1.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: csp-resolver
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - André Benjamim
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-05-16 00:00:00.000000000 Z
+date: 2024-06-10 00:00:00.000000000 Z
 dependencies: []
 description: This Ruby gem solves CSPs using custom constraints
 email:
@@ -20,6 +20,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - MIT-LICENSE
 - README.md
 - Rakefile
@@ -60,7 +62,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubyforge_project: 
+rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
 summary: A Ruby CSP Solver