dotenv-android 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f6a53019c82367cac781d5b598a0c03bb46e1712d28317d236fdb26b630a868
-  data.tar.gz: 25a44ce79404add065ff8e23a46405c67e1141c8b82c68a6fe42086f474ed920
+  metadata.gz: bf9107a7eac6ffceeeaf4712d9e70915ad47c9d5577eb76be97360b97b85addd
+  data.tar.gz: 5dfbc805c2c8331ad16a9d421767ab94401970629dbc768627f5634901365cd0
 SHA512:
-  metadata.gz: de0253f90662bd6a45c4afecbd8bd6184290867a9597ae448fb21770213e06afd1d32010e32c424980f67d4d256dc24174f1d6771951954324bb6169b3a8fc3f
-  data.tar.gz: 771fe82ea8241df5466da3f1e0a7a4267a20f9cfcfe6b72c15c3f278d4329f694639cecda3f939a47ab13c4e53eacf550c70be8dcc4609bd6cd204c1e8384104
+  metadata.gz: 20651196c68f0a337f54d62f4a694f8d6eb76db602073ed9b251eddc93b1dd556f4b2639b298cf0f10c869eef8d053eb388b7f4d20666dc10845fcf9d55054ae
+  data.tar.gz: a360617fcb5d34ad1bb244a293b006bfe86dce259b8657cb20a872ee8451d78af1dcb6d8cc48d9690913a70ab62c0a977b1fb0200e88a1e43f524775d5b5c77a

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# [0.1.1] - 2019-11-30
+
+## Fixed 
+- Tested out CLI on a local Android Studio project and found bugs with it. 
+- Fix README docs on how to create Gradle build task. 
+
 # [0.1.0] - 2019-11-30
 
 ## Added

data/README.md

@@ -22,17 +22,26 @@ gem install dotenv-android
 val apiHost: String = Env.apiHost
 ```
 
-At first, Android Studio will complain that `Env.apiHost` cannot be found. Don't worry. We will be fixing that. `dotenv-android` CLI crawls your source code looking for `Env.X` requests and generating a `Env.kt` file for you! Anytime you want to use environmental variables, you just need to add it to your source. Super easy. 
+At first, Android Studio will complain that `Env.apiHost` cannot be found. Don't worry. We will be fixing that. `dotenv-android` CLI crawls your source code looking for `Env.X` requests and generating a `Env.kt` file for you! Anytime you want to use environmental variables, you just need to add it to your source. Super easy. If `dotenv-android` cannot find the variable in your `.env` file, it will throw an error so you can feel confident that if your app compiles, everything will work great. 
 
-* In your `app/build.gradle` file, add the following to the bottom of the file:
+* Create a bash script in the root of your project, `generate_env.sh`, with the contents:
 
 ```
-task buildEnv << {
-    dotenv-android --source app/src/main/java/com/example/
-}
+#!/bin/bash
+
+dotenv-android --source app/src/main/java/com/example/myapplication/ --package PACKAGE_NAME
+```
 
-build.dependsOn buildEnv
+In your `app/build.gradle` file, add the following to the bottom of the file:
 ```
+task generateEnv(type:Exec) {
+    workingDir '../'
+    commandLine './generate_env.sh'
+}
+preBuild.dependsOn generateEnv
+```
+
+You have just created a Gradle task that will run every time that you build your app. This will run the `dotenv-android` CLI to generate the `Env.kt` file each time you build! 
 
 * Run a build in Android Studio to run the `dotenv-android` CLI tool. 
 

data/lib/dotenv-android/cli.rb

@@ -11,7 +11,7 @@ require_relative './version'
 require 'dotenv'
 
 module DotEnvAndroid
-  Options = Struct.new(:source, :out, :verbose, :debug)
+  Options = Struct.new(:source, :out, :verbose, :debug, :package_name)
 
   class CLI
     def initialize
@@ -47,6 +47,9 @@ module DotEnvAndroid
           options.verbose = true
           options.debug = true
         end
+        opts.on('--package PACKAGE_NAME', 'Package name to add to the top of the generated Env.kt file (example: com.yourdomain.app, or PACKAGE_NAME environment variable found in .env)') do |package_name|
+          options.package_name = package_name
+        end
         opts.on('-o', '--out FILE', 'Output file (example: Path/Env.kt)') do |out|
           options.out = out
         end
@@ -67,6 +70,7 @@ module DotEnvAndroid
     def assert_options
       prefix = '[ERROR]'
       @ui.fail("#{prefix} --source required") unless @options.source
+      @ui.fail("#{prefix} --package required") unless @options.package_name
     end
   end
 end

data/lib/dotenv-android/generator.rb

@@ -14,6 +14,8 @@ module DotEnvAndroid
       @options = options
 
       @ui = DotEnvAndroid::UI.new(@options.verbose, @options.debug)
+
+      @all_env_vars = Dotenv.parse('.env')
     end
 
     def start
@@ -23,7 +25,7 @@ module DotEnvAndroid
     end
 
     def iterate_source
-      source_pattern = File.expand_path("#{@options.source}/**/*.kotlin")
+      source_pattern = File.expand_path("#{@options.source}/**/*.kt")
       @ui.verbose("Searching for environment vars in source: #{source_pattern}")
 
       requests = Set[]
@@ -58,24 +60,39 @@ module DotEnvAndroid
       requests
     end
 
-    def get_values(requests)
-      variables = Dotenv.parse('.env')
+    def get_values(requests)      
       values = {}
 
       requests.each do |request|
-        @ui.fail("Environment variable #{request} not found in .env") unless variables[request]
+        @ui.fail("Environment variable #{request} not found in .env") unless @all_env_vars[request]
 
-        values[request] = variables[request]
+        values[request] = @all_env_vars[request]
       end
 
       @ui.debug("Values: #{values}")
       values
     end
 
+    def get_package_header
+      package_name_header = "package #{@options.package_name}"
+
+      if !@options.package_name.include? "."
+        package_name = @all_env_vars[@options.package_name]
+        @ui.fail("Cannot find package name in .env file with key, #{@options.package_name}") if package_name.nil?
+        package_name_header = "package #{package_name}"
+      end 
+
+      @ui.debug("Package name header: #{package_name_header}")
+
+      return package_name_header
+    end 
+
     def generate_output(env_variables)
       @ui.verbose("Outputting environment variables to #{@options.out}")
 
-      file_contents = "object Env {\n\n"
+      package_name_header = get_package_header
+      file_contents = "#{package_name_header}\n\n"      
+      file_contents += "object Env {\n\n"
       env_variables.each do |key, value|
         file_contents += "  val #{DotEnvAndroid::Util.snake_to_camel(key)} = \"#{value}\"\n"
       end

data/lib/dotenv-android/version.rb

@@ -3,7 +3,7 @@
 module DotEnvAndroid
   class Version
     def self.get
-      '0.1.0'
+      '0.1.1'
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dotenv-android
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Levi Bostian