arkana 1.4.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22608014d403cf3e16f5d5f13d92cbab02691de72f98492de289c0a1cb53ed64
-  data.tar.gz: ba1209829e1ac32b881febadcfc74dca440cdaab81a259dc7d034c1ab3363306
+  metadata.gz: 1f589f9e9d3ccd550915af3bb90a46717e385e5e7691d1a92a69da3352f187eb
+  data.tar.gz: 4871dcda8ae09e6c39d2d94ec0bad3798cdb6b9dec6a1b50e4b7fc6e97231980
 SHA512:
-  metadata.gz: 58de3a4b5cf38c589de28dfb656a84f8b9c8e1464996eed8573acd119d6468fb2ec8c3cf0c5fea7df76a57b1cf099b58aa69bf1804a301176ac2b5af583e2c6c
-  data.tar.gz: 4591ab624fdf27570fbf78b084124b131ed8af389be6dba34ed2a3d81f456f093825ae436c4af6bab5f6250453a4aa6ac6aed7ba7f42013a11c18338f75a1712
+  metadata.gz: 2dbf5f95c13a18d75f82c0598818e0e4b580e10cdbdf9a10c283c6151a7c1b94b21cd740f849dcf70351ace776a50741c320d22871ab1bda086a29136e715c52
+  data.tar.gz: 42ac12f877d80cc5f6e858db44fb78106e260fd1775e43bd7e3c82b8bea1206acb9ab174c4e00249d57c2990b0225593ea81bf7790a2b661171025a2f6c2b92e

data/lib/arkana/config_parser.rb

@@ -12,6 +12,7 @@ module ConfigParser
   def self.parse(arguments)
     yaml = YAML.load_file(arguments.config_filepath)
     config = Config.new(yaml)
+    config.include_environments(arguments.include_environments)
     config.current_flavor = arguments.flavor
     config.dotenv_filepath = arguments.dotenv_filepath
     UI.warn("Dotenv file was specified but couldn't be found at '#{config.dotenv_filepath}'") if config.dotenv_filepath && !File.exist?(config.dotenv_filepath)

data/lib/arkana/helpers/swift_template_helper.rb

@@ -4,18 +4,18 @@
 module SwiftTemplateHelper
   def self.swift_type(type)
     case type
-    when :string then "String"
-    when :boolean then "Bool"
-    when :integer then "Int"
-    else raise "Unknown variable type '#{type}' received.'"
+      when :string then "String"
+      when :boolean then "Bool"
+      when :integer then "Int"
+      else raise "Unknown variable type '#{type}' received.'"
     end
   end
 
   def self.protocol_getter(declaration_strategy)
     case declaration_strategy
-    when "lazy var" then "mutating get"
-    when "var", "let" then "get"
-    else raise "Unknown declaration strategy '#{declaration_strategy}' received.'"
+      when "lazy var" then "mutating get"
+      when "var", "let" then "get"
+      else raise "Unknown declaration strategy '#{declaration_strategy}' received.'"
     end
   end
 end

data/lib/arkana/models/arguments.rb

@@ -10,12 +10,15 @@ class Arguments
   attr_reader :dotenv_filepath
   # @returns [string]
   attr_reader :flavor
+  # @returns [Array<string>]
+  attr_reader :include_environments
 
   def initialize
     # Default values
     @config_filepath = ".arkana.yml"
     @dotenv_filepath = ".env" if File.exist?(".env")
     @flavor = nil
+    @include_environments = nil
 
     OptionParser.new do |opt|
       opt.on("-c", "--config-filepath /path/to/your/.arkana.yml", "Path to your config file. Defaults to '.arkana.yml'") do |o|
@@ -27,6 +30,9 @@ class Arguments
       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|
+        @include_environments = o.split(",")
+      end
     end.parse!
   end
 end

data/lib/arkana/models/config.rb

@@ -24,6 +24,8 @@ class Config
   attr_reader :should_generate_unit_tests
   # @returns [string]
   attr_reader :package_manager
+  # @returns [boolean]
+  attr_reader :should_cocoapods_cross_import_modules
 
   # @returns [string]
   attr_accessor :current_flavor
@@ -45,6 +47,8 @@ class Config
     @should_generate_unit_tests = yaml["should_generate_unit_tests"]
     @should_generate_unit_tests = true if @should_generate_unit_tests.nil?
     @package_manager = yaml["package_manager"] || "spm"
+    @should_cocoapods_cross_import_modules = yaml["should_cocoapods_cross_import_modules"]
+    @should_cocoapods_cross_import_modules = true if @should_cocoapods_cross_import_modules.nil?
   end
   # rubocop:enable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
 
@@ -59,4 +63,10 @@ class Config
   def all_keys
     global_secrets + environment_keys
   end
+
+  def include_environments(environments)
+    return unless environments
+
+    @environments = @environments.select { |e| environments.map(&:downcase).include?(e.downcase) }
+  end
 end

data/lib/arkana/models/template_arguments.rb

@@ -24,6 +24,8 @@ class TemplateArguments
     @swift_declaration_strategy = config.swift_declaration_strategy
     # Whether unit tests should be generated.
     @should_generate_unit_tests = config.should_generate_unit_tests
+    # Whether cocoapods modules should cross import.
+    @should_cocoapods_cross_import_modules = config.should_cocoapods_cross_import_modules
   end
 
   def environment_protocol_secrets(environment)

data/lib/arkana/models/type.rb

@@ -8,12 +8,16 @@ module Type
 
   def self.new(string_value:)
     case string_value
-    when "true", "false"
-      BOOLEAN
-    when /^\d+$/
-      INTEGER
-    else
-      STRING
+      when "true", "false"
+        BOOLEAN
+      when /^\d+$/
+        # Handles cases like "0001" which should be interpreted as strings
+        return STRING if string_value.to_i.to_s != string_value
+        # Handle int overflow
+        return STRING if string_value.to_i > (2**31) - 1
+        INTEGER
+      else
+        STRING
     end
   end
 end

data/lib/arkana/templates/arkana.swift.erb

@@ -5,7 +5,14 @@
 // Automatically generated by Arkana (https://github.com/rogerluan/arkana)
 
 import Foundation
+<% if !@should_cocoapods_cross_import_modules %>
+#if COCOAPODS
+#else
+<% end %>
 import <%= @import_name %>Interfaces
+<% if !@should_cocoapods_cross_import_modules %>
+#endif
+<% end %>
 
 public enum <%= @namespace %> {
     @inline(__always)

data/lib/arkana/templates/arkana_tests.swift.erb

@@ -86,6 +86,46 @@ final class <%= @namespace %>Tests: XCTestCase {
         XCTAssertEqual(<%= @namespace %>.decode(encoded: encoded, cipher: salt), 42)
     }
 
+    func test_decodeIntValueWithLeadingZeroes_shouldDecodeAsString() {
+<% int_with_leading_zeroes_key = "0001" %>
+<% secret = generate_test_secret(key: int_with_leading_zeroes_key) %>
+        let encoded: [UInt8] = [
+            <%= secret.encoded_value %>
+
+        ]
+        XCTAssertEqual(<%= @namespace %>.decode(encoded: encoded, cipher: salt), "0001")
+    }
+
+    func test_decodeMassiveIntValue_shouldDecodeAsString() {
+<% int_with_massive_number_key = "92233720368547758079223372036854775807" %>
+<% secret = generate_test_secret(key: int_with_massive_number_key) %>
+        let encoded: [UInt8] = [
+            <%= secret.encoded_value %>
+
+        ]
+        XCTAssertEqual(<%= @namespace %>.decode(encoded: encoded, cipher: salt), "92233720368547758079223372036854775807")
+    }
+
+    func test_decodeNegativeIntValue_shouldDecodeAsString() {
+<% negative_int_key = "-42" %>
+<% secret = generate_test_secret(key: negative_int_key) %>
+        let encoded: [UInt8] = [
+            <%= secret.encoded_value %>
+
+        ]
+        XCTAssertEqual(<%= @namespace %>.decode(encoded: encoded, cipher: salt), "-42")
+    }
+
+    func test_decodeFloatingPointValue_shouldDecodeAsString() {
+<% float_key = "3.14" %>
+<% secret = generate_test_secret(key: float_key) %>
+        let encoded: [UInt8] = [
+            <%= secret.encoded_value %>
+
+        ]
+        XCTAssertEqual(<%= @namespace %>.decode(encoded: encoded, cipher: salt), "3.14")
+    }
+
     func test_encodeAndDecodeValueWithDollarSign_shouldDecode() {
 <% dollar_sign_key = "real_$lim_shady" %>
 <% secret = generate_test_secret(key: dollar_sign_key) %>
@@ -95,6 +135,7 @@ final class <%= @namespace %>Tests: XCTestCase {
         ]
         XCTAssertEqual(<%= @namespace %>.decode(encoded: encoded, cipher: salt), "real_$lim_shady")
     }
+<% if ENV["ARKANA_RUNNING_CI_INTEGRATION_TESTS"] %>
 
     func test_decodeEnvVarFromDotfile_withDollarSign__andEscaped_andNoQuotes_shouldDecode() {
         XCTAssertEqual(globalSecrets.secretWithDollarSignEscapedAndAndNoQuotesKey, "real_$lim_shady")
@@ -119,4 +160,5 @@ final class <%= @namespace %>Tests: XCTestCase {
     func test_decodeEnvVarFromDotfile_withWeirdCharacters_shouldDecode() {
         XCTAssertEqual(globalSecrets.secretWithWeirdCharactersKey, "` ~ ! @ # % ^ & * ( ) _ - + = { [ } } | : ; ' < , > . ? /")
     }
+<% end %>
 }

data/lib/arkana/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Arkana
-  VERSION = "1.4.0"
+  VERSION = "1.6.0"
 end

data/lib/arkana.rb

@@ -3,6 +3,7 @@
 require_relative "arkana/config_parser"
 require_relative "arkana/encoder"
 require_relative "arkana/helpers/dotenv_helper"
+require_relative "arkana/helpers/ui"
 require_relative "arkana/models/template_arguments"
 require_relative "arkana/salt_generator"
 require_relative "arkana/swift_code_generator"
@@ -30,11 +31,11 @@ module Arkana
       )
     rescue StandardError => e
       # TODO: Improve this by creating an Env/Debug helper
-      puts("Something went wrong when parsing and encoding your secrets.")
-      puts("Current Flavor: #{config.current_flavor}")
-      puts("Dotenv Filepath: #{config.dotenv_filepath}")
-      puts("Config Filepath: #{arguments.config_filepath}")
-      raise e
+      UI.warn("Something went wrong when parsing and encoding your secrets.")
+      UI.warn("Current Flavor: #{config.current_flavor}")
+      UI.warn("Dotenv Filepath: #{config.dotenv_filepath}")
+      UI.warn("Config Filepath: #{arguments.config_filepath}")
+      UI.crash(e.message)
     end
     template_arguments = TemplateArguments.new(
       environment_secrets: environment_secrets,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: arkana
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Roger Oba
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-01 00:00:00.000000000 Z
+date: 2023-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -105,14 +105,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.9
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Store your keys and secrets away from your source code. Designed for Android