dotenv-ios 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '028bc8ba2b914550dfda93c441f49551ccc780da06adebbf7537c637dc3f1826'
+  data.tar.gz: 565963f35047f3b03f70d8564db9a1bdee3661e462022e7d4d41215922266ff1
+SHA512:
+  metadata.gz: ddfccdf062a1cf7c50e15c9134bfc19f02ba64a5312f6ae492f0e61016939e488af36c64e6998ac8a5102e8619cf08c883dd1c0d1c6aa0dba629f5cb854ed848
+  data.tar.gz: 744cfe0508b946dab9688e252f1c7659912139af0864cab79da50669c9db6af33f4194affb9f41c87a58f5f954921e3fdbad1200aa7a5e1a9e68a531b46619b8

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+# [0.1.0] - 2019-11-30
+
+## Added 
+- Create CLI that reads `.env` files and generates `Env.swift` file with values requested in source code. 

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2019 Levi Bostian <levi.bostian@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,65 @@
+# dotenv-ios
+
+Give access to `.env` environment variables file within your iOS projects. 
+
+`dotenv-ios` is a simple CLI tool you can run on each XCode build to inject environment variables into your iOS app. This tool was inspired by [the twelve-factor app](https://12factor.net/config) to make environmental changes in your app simple. 
+
+*Note: At this time, only Swift is supported.*
+
+# Getting started
+
+* Install this tool:
+
+```
+gem install dotenv-ios
+```
+
+* In the root of your iOS project, create a `.env` file and store all of the environment variables you wish inside. (Make sure to add this file to your `.gitignore` to avoid checking it into source control!)
+
+* In your iOS app's source code, reference environment variables that you want to use:
+
+```swift
+let apiHost: String = Env.apiHost
+```
+
+At first, XCode will complain that `Env.apiHost` cannot be found. Don't worry. We will be fixing that. `dotenv-ios` CLI crawls your source code looking for `Env.X` requests and generating a `Env.swift` file for you! Anytime you want to use environmental variables, you just need to add it to your source. Super easy. 
+
+* Create a new Build Phase in XCode to run this command. 
+
+The shell command for this build phase is quite simple: `dotenv-ios --source PathToYourSourceCode/`
+
+Reorder the new Build Phase to be first to run. That way this tool can generate the environment variables before XCode tries to compile your app's source code. 
+
+* Run a build in XCode (Cmd + B) to run the `dotenv-ios` CLI tool. 
+
+* Add the newly generated `PathToYourSourceCode/Env.swift` file to your XCode project. 
+
+* Done! 
+
+## Development 
+
+```bash
+$> bundle install
+```
+
+You're ready to start developing! 
+
+## Deployment 
+
+This gem is setup automatically to deploy to RubyGems on a git tag deployment. 
+
+* Add `RUBYGEMS_KEY` secret to Travis-CI's settings. 
+* Make a new git tag, push it up to GitHub. Travis will deploy for you. 
+
+## Author
+
+* Levi Bostian - [GitHub](https://github.com/levibostian), [Twitter](https://twitter.com/levibostian), [Website/blog](http://levibostian.com)
+
+![Levi Bostian image](https://gravatar.com/avatar/22355580305146b21508c74ff6b44bc5?s=250)
+
+## Contribute
+
+dotenv-ios is open for pull requests. Check out the [list of issues](https://github.com/levibostian/dotenv-ios/issues) for tasks I am planning on working on. Check them out if you wish to contribute in that way.
+
+**Want to add features?** Before you decide to take a bunch of time and add functionality to the library, please, [create an issue]
+(https://github.com/levibostian/dotenv-ios/issues/new) stating what you wish to add. This might save you some time in case your purpose does not fit well in the use cases of this project.

data/bin/dotenv-ios

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'dotenv-ios'
+
+DotEnviOS::CLI.new

data/lib/dotenv-ios/cli.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require 'colorize'
+require 'optparse'
+require 'set'
+require 'pathname'
+require_relative './ui'
+require_relative './util'
+require_relative './generator'
+require_relative './version'
+require 'dotenv'
+
+module DotEnviOS
+  Options = Struct.new(:source, :out, :verbose, :debug)
+
+  class CLI
+    def initialize
+      @options = parse_options
+
+      @ui = DotEnviOS::UI.new(@options.verbose, @options.debug)
+
+      assert_options
+
+      DotEnviOS::Generator.new(@options).start
+    end
+
+    def parse_options
+      options = Options.new
+      options.verbose = false
+      options.debug = false
+
+      opt_parser = OptionParser.new do |opts|
+        opts.banner = 'Usage: dotenv-ios [options]'
+
+        opts.on('-v', '--version', 'Print version') do
+          puts DotEnviOS::Version.get
+          exit
+        end
+        opts.on('-s', '--source DIR', 'Source code directory to check for requested environment variables') do |source|
+          options.source = source
+          options.out = Pathname.new(source).join('Env.swift') # set default
+        end
+        opts.on('--verbose', 'Verbose output') do
+          options.verbose = true
+        end
+        opts.on('--debug', 'Debug output (also turns on verbose)') do
+          options.verbose = true
+          options.debug = true
+        end
+        opts.on('-o', '--out FILE', 'Output file') do |out|
+          options.out = out
+        end
+        opts.on('-h', '--help', 'Prints this help') do
+          puts opts
+          exit
+        end
+      end
+
+      help = opt_parser.help
+      abort(help) if ARGV.empty?
+
+      opt_parser.parse!(ARGV)
+
+      options
+    end
+
+    def assert_options
+      prefix = '[ERROR]'
+      @ui.fail("#{prefix} --source required") unless @options.source
+    end
+  end
+end

data/lib/dotenv-ios/generator.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+require 'colorize'
+require 'optparse'
+require 'set'
+require 'pathname'
+require_relative './ui'
+require_relative './util'
+require 'dotenv'
+
+module DotEnviOS
+  class Generator
+    def initialize(options)
+      @options = options
+
+      @ui = DotEnviOS::UI.new(@options.verbose, @options.debug)
+    end
+
+    def start
+      requests = iterate_source
+      env_variables = get_values(requests)
+      generate_output(env_variables)
+    end
+
+    def iterate_source
+      source_pattern = File.expand_path("#{@options.source}/**/*.swift")
+      @ui.verbose("Searching for environment vars in source: #{source_pattern}")
+
+      requests = Set[]
+
+      Dir.glob(source_pattern) do |swift_file|
+        next if File.directory? swift_file
+
+        @ui.verbose("Looking for Env usage in: #{swift_file}")
+        requests.merge(get_env_requests(swift_file))
+        @ui.verbose("Found #{requests.count} requests")
+        @ui.debug("Requests found for file: #{requests.to_a}")
+      end
+
+      requests.to_a
+    end
+
+    def get_env_requests(file)
+      requests = []
+
+      File.readlines(file).each do |line|
+        line.split(' ').each do |word|
+          # https://regexr.com/4pmp0
+          next unless /Env\.[a-z]\w*/.match? word
+
+          requested_variable = word.split('.')[1]
+          requested_variable = DotEnviOS::Util.to_snakecase(requested_variable).upcase
+
+          requests.push(requested_variable)
+        end
+      end
+
+      requests
+    end
+
+    def get_values(requests)
+      variables = Dotenv.parse('.env')
+      values = {}
+
+      requests.each do |request|
+        @ui.fail("Environment variable #{request} not found in .env") unless variables[request]
+
+        values[request] = variables[request]
+      end
+
+      @ui.debug("Values: #{values}")
+      values
+    end
+
+    def generate_output(env_variables)
+      @ui.verbose("Outputting environment variables to #{@options.out}")
+
+      file_contents = "class Env {\n\n"
+      env_variables.each do |key, value|
+        file_contents += "  static var #{DotEnviOS::Util.snake_to_camel(key)}: String = \"#{value}\"\n"
+      end
+
+      file_contents += "\n}"
+
+      @ui.debug("Output file: #{file_contents}")
+
+      File.open(@options.out, 'w') { |file| file.write(file_contents) }
+
+      @ui.success('Environment variables file generated!')
+      @ui.success("Add file, #{@options.out}, to your XCode project")
+    end
+  end
+end

data/lib/dotenv-ios/ui.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'colorize'
+require 'optparse'
+
+module DotEnviOS
+  class UI
+    def initialize(verbose, debug)
+      @verbose = verbose
+      @debug = debug
+    end
+
+    def success(message)
+      puts message.colorize(:green)
+    end
+
+    def fail(message)
+      abort(message.colorize(:red))
+    end
+
+    def warning(message)
+      puts message.to_s.colorize(:yellow)
+    end
+
+    def verbose(message)
+      puts message.to_s if @verbose
+    end
+
+    def debug(message)
+      puts message.to_s.colorize(:light_blue) if @debug
+    end
+  end
+end

data/lib/dotenv-ios/util.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module DotEnviOS
+  class Util
+    def self.to_snakecase(string)
+      string.gsub(/(.)([A-Z])/, '\1_\2').downcase
+    end
+
+    def self.snake_to_camel(string)
+      # takes API_HOST => ApiHost
+      s = string.split('_').collect(&:capitalize).join
+      # Takes ApiHost => apiHost
+      s[0] = s[0].downcase
+      s
+    end
+  end
+end

data/lib/dotenv-ios/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module DotEnviOS
+  class Version
+    def self.get
+      '0.1.0'
+    end
+  end
+end

data/lib/dotenv_ios.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'dotenv-ios/cli'

metadata

@@ -0,0 +1,177 @@
+--- !ruby/object:Gem::Specification
+name: dotenv-ios
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Levi Bostian
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-11-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.5
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.58'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.58.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.58'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.58.2
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+description: It is said to be good practice when you configure your app with a .env
+  file. This library will (1) scan your source code looking for requests for environment
+  variables, (2) parse a .env file and the variables defined on the machine, and (3)
+  generate source code file to compile into app.
+email: levi.bostian@gmail.com
+executables:
+- dotenv-ios
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- bin/dotenv-ios
+- lib/dotenv-ios/cli.rb
+- lib/dotenv-ios/generator.rb
+- lib/dotenv-ios/ui.rb
+- lib/dotenv-ios/util.rb
+- lib/dotenv-ios/version.rb
+- lib/dotenv_ios.rb
+homepage: http://github.com/levibostian/dotenv-ios
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: Access environment variables at runtime of iOS app
+test_files: []