Merge branch 'main' into kotlin-support

# Conflicts:
#	template.yml

.github/workflows/push.yml

@@ -20,7 +20,7 @@ jobs:
       with:
         ruby-version: ${{ matrix.ruby }}
         bundler-cache: true # runs 'bundle install' and caches installed gems automatically
-    - uses: paambaati/codeclimate-action@v4.0.0
+    - uses: paambaati/codeclimate-action@v5.0.0
       with:
         coverageCommand: bundle exec rake
         debug: true

.github/workflows/swift-tests.yml

@@ -9,6 +9,6 @@ jobs:
     - uses: ruby/setup-ruby@v1
       with:
         ruby-version: '3.1'
-        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+        bundler-cache: true # Runs 'bundle install' and caches installed gems automatically
     - name: Generate Swift Code & Run Tests
       run: bundle exec rake test_swift

README.md

@@ -409,17 +409,17 @@ Special thanks to [@danilobecke](https://github.com/danilobecke) for the inspira
 
 # Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`.
 
 To bump the lib's version, run `bundle exec rake bump[1.2.3]` (replacing the value with the desired version).
 
-To release a new version, update the version number in `version.rb` (likely done via `rake bump` above), and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To release a new version, make sure the version number in `version.rb` is the one you want to release (after setting it via `bundle exec rake bump` as shown above), and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 # Contributing
 
-If you spot something wrong, missing, or if you'd like to propose improvements to this project, please open an Issue or a Pull Request with your ideas and I promise to get back to you within 24 hours! 😇
+Contributions to Arkana are warmly welcomed. Whether it's bug reports, feature requests, or code contributions, your input is highly valued. Please feel free to submit issues and pull requests with your ideas and I promise to get back to you within 24 hours! 😇
 
 This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](CODE_OF_CONDUCT.md).
 

lib/arkana/models/arguments.rb

@@ -33,7 +33,7 @@ def initialize
       opt.on("-f", "--flavor FrostedFlakes", "Flavors are useful, for instance, when generating secrets for white-label projects. See the README for more information") do |o|
         @flavor = o
       end
-      opt.on("-i", "--include-environments debug,release", "Optionally pass the environments that you want Arkana to generate secrets for. Useful if you only want to build a certain environment, e.g. just Debug in local machines, while only building Staging and Release in CI. Separate the keys using a comma, without spaces. When ommitted, Arkana generate secrets for all environments.") do |o|
+      opt.on("-i", "--include-environments debug,release", "Optionally pass the environments that you want Arkana to generate secrets for. Useful if you only want to build a certain environment, e.g. just Debug in local machines, while only building Staging and Release in CI. Separate the keys using a comma, without spaces. When omitted, Arkana generate secrets for all environments.") do |o|
         @include_environments = o.split(",")
       end
       opt.on("-l", "--lang kotlin", "Language to produce keys for, e.g. kotlin, swift. Defaults to 'swift'. See the README for more information") do |o|

lib/arkana/templates/readme.erb

@@ -1,4 +1,4 @@
 # <%= @namespace %>
 
 
-This Package is autogenerated by [Arkana](https://github.com/rogerluan/arkana). Do not attempt to modify it manually, otherwise your changes will be overriden on the next code generation process. Please visit [Arkana](https://github.com/rogerluan/arkana) to read more.
+This Package is autogenerated by [Arkana](https://github.com/rogerluan/arkana). Do not attempt to modify it manually, otherwise your changes will be overridden on the next code generation process. Please visit [Arkana](https://github.com/rogerluan/arkana) to read more.

lib/arkana/templates/swift/interfaces_readme.erb

@@ -1,3 +1,3 @@
 # <%= @namespace %>Interfaces
 
-This Package was autogenerated by [Arkana](https://github.com/rogerluan/arkana). Do not attempt to modify it manually, otherwise your changes will be overriden in the next code generation process. Please visit [Arkana](https://github.com/rogerluan/arkana) to read more.
+This Package was autogenerated by [Arkana](https://github.com/rogerluan/arkana). Do not attempt to modify it manually, otherwise your changes will be overridden in the next code generation process. Please visit [Arkana](https://github.com/rogerluan/arkana) to read more.

spec/models/arguments_spec.rb

@@ -8,7 +8,7 @@
   before { ARGV.replace([]) }
 
   describe "#config_filepath" do
-    context "when the option is ommitted in ARGV" do
+    context "when the option is omitted in ARGV" do
       it "defaults to the default value" do
         expect(subject.config_filepath).to eq ".arkana.yml"
       end
@@ -26,7 +26,7 @@
   end
 
   describe "#dotenv_filepath" do
-    context "when the option is ommitted in ARGV" do
+    context "when the option is omitted in ARGV" do
       describe "when .env file exists" do
         it "defaults to the default value" do
           expect(File).to receive(:exist?).with(".env").and_return(true)
@@ -54,7 +54,7 @@
   end
 
   describe "#flavor" do
-    context "when the option is ommitted in ARGV" do
+    context "when the option is omitted in ARGV" do
       it "defaults to nil" do
         expect(subject.flavor).to be_nil
       end
@@ -72,7 +72,7 @@
   end
 
   describe "#environments" do
-    context "when the option is ommitted in ARGV" do
+    context "when the option is omitted in ARGV" do
       it "defaults to nil" do
         expect(subject.include_environments).to be_nil
       end

template.yml

@@ -8,7 +8,7 @@ flavors: # Optional. Flavors are keywords added as a prefix to every secret when
 swift_declaration_strategy: let # Optional. One of: lazy var, var, let. Defaults to let.
 should_generate_unit_tests: true # Optional. One of: true, false. Defaults to true.
 should_cocoapods_cross_import_modules: true # Optional. If false, the two generated cocoapods pods do not cross import (for manual import of the Sources folders), useful when building SDKs, for instance. One of: true, false. Defaults to true.
-package_manager: cocoapods # Optional. This setting defines which type of dependency management you're going ot use to integrate Arkana into your project. One of: spm, cocoapods. If you use both in your project, use cocoapods here. Defaults to spm.
+package_manager: cocoapods # Optional. This setting defines which type of dependency management you're going to use to integrate Arkana into your project. One of: spm, cocoapods. If you use both in your project, use cocoapods here. Defaults to spm.
 kotlin_package_name: 'com.arkanakeys' # Optional. The package name of the generated Kotlin module. Defaults to com.arkanakeys.
 kotlin_sources_path: 'java' # Optional. The path for the generated Kotlin classes. Defaults to kotlin.
 should_generate_gradle_build_file: true # Optional. Whether a build.gradle file should be generated, when running the Kotlin generator. One of: true, false. Defaults to true.