fastlane_core 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ce6315db355b51ee4d502ab055dbdfe93ef53425
-  data.tar.gz: d831602adf386b7b227459fb196110d6b4963b50
+  metadata.gz: 0b71366adf4b314624463dc2ea6071a1b45fdfaa
+  data.tar.gz: d9c384d0df79afa89da41c937372cc9fbbee1989
 SHA512:
-  metadata.gz: d86a26d83cb4eb0f372ecfd30a8f84bcab3c535230f1285e1895ddb52dfd1719da81d3333101ed33ced6c609653f0b31b05e4e5277647cb5c1c33853fad12df7
-  data.tar.gz: 45d8b9ba85e135cd98f276b2e3f8ec0fe89ab3bfd488a85ea037b6cf32deef84462de0e11b8a6f8f318b72adaeda1636f28f81f1e7dd89b92b5e2f3eb3f2604f
+  metadata.gz: d641d8f801d277a98e409985206c90690206517a5bd851c11a751da5a9e88ea41c3670d7b1a0a183d5b08c168f52aaa845bfa550288c31ced46faa9604701713
+  data.tar.gz: 1486be1a878cadb6385965a19fc9dfe6231811de878ea76b530078945f7e7d137dc65951a4b9588c6cbee97af3b1337f30aa892af5c5e5e2fcdd90f8aade247c

data/lib/fastlane_core.rb

@@ -1,6 +1,7 @@
 require 'json'
 require 'fastlane_core/version'
 require 'fastlane_core/helper'
+require 'fastlane_core/configuration'
 require 'fastlane_core/update_checker'
 require 'fastlane_core/languages'
 require 'fastlane_core/itunes_search_api'

data/lib/fastlane_core/configuration.rb

@@ -0,0 +1,108 @@
+require 'fastlane_core/configuration/config_item'
+require 'fastlane_core/configuration/commander_generator'
+
+module FastlaneCore
+  class Configuration
+    def self.create(available_options, values)
+      Configuration.new(available_options, values)
+    end
+
+    # Setting up
+
+    def initialize(available_options, values)
+      @available_options = available_options
+      @values = values
+
+      verify_input_types      
+      verify_value_exists
+      verify_no_duplicates
+    end
+
+    def verify_input_types
+      raise "available_options parameter must be an array of ConfigItems".red unless @available_options.kind_of?Array
+      @available_options.each do |item|
+        raise "available_options parameter must be an array of ConfigItems".red unless item.kind_of?ConfigItem
+      end
+      raise "values parameter must be a hash".red unless @values.kind_of?Hash
+    end
+
+    def verify_value_exists
+      # Make sure the given value keys exist
+      @values.each do |key, value|
+        option = option_for_key(key)
+        if option
+          option.verify!(value) # Call the verify block for it too
+        else
+          raise "Could not find available option '#{key}' in the list of available options #{@available_options.collect { |a| a.key }}".red
+        end
+      end
+    end
+
+    def verify_no_duplicates
+      # Make sure a key was not used multiple times
+      @available_options.each do |current|
+        count = @available_options.select { |option| option.key == current.key }.count
+        raise "Multiple entries for configuration key '#{current.key}' found!".red if count > 1
+
+        unless current.short_option.to_s.empty?
+          count = @available_options.select { |option| option.short_option == current.short_option }.count
+          raise "Multiple entries for short_option '#{current.short_option}' found!".red if count > 1
+        end
+      end
+    end
+
+    # Using the class
+
+    # Returns the value for a certain key. fastlane_core tries to fetch the value from different sources
+    def fetch(key)
+      raise "Key '#{key}' must be a symbol. Example :app_id.".red unless key.kind_of?Symbol
+
+      option = option_for_key(key)
+      raise "Could not find option for key :#{key}. Available keys: #{@available_options.collect { |a| a.key }}".red unless option
+
+      # `if value == nil` instead of ||= because false is also a valid value
+
+      value ||= @values[key]
+      # TODO: configuration files
+      value = ENV[key.to_s] if value == nil
+      value = option.default_value if value == nil
+      value = false if (value == nil and not option.is_string) # by default boolean flags are false
+
+      while value == nil and !option.optional
+        value = ask("#{option.description}: ")
+        # Also store this value to use it from now on
+        begin
+          set(key, value)
+        rescue Exception => ex
+          puts ex
+          value = nil
+        end
+      end
+
+      value
+    end
+
+    # Overwrites or sets a new value for a given key
+    def set(key, value)
+      raise "Key '#{key}' must be a symbol. Example :app_id.".red unless key.kind_of?Symbol
+      option = option_for_key(key)
+      
+      unless option
+        raise "Could not find available option '#{key}' in the list of !available options #{@available_options.collect { |a| a.key }}".red
+      end
+
+      option.verify!(value)
+
+      @values[key] = value
+      true
+    end
+
+    # Returns the config_item object for a given key
+    def option_for_key(key)
+      @available_options.find { |o| o.key == key }
+    end
+
+    # Aliases `[key]` to `fetch(key)` because Ruby can do it.
+    alias_method :[], :fetch
+  end
+end

data/lib/fastlane_core/configuration/commander_generator.rb

@@ -0,0 +1,16 @@
+require 'commander'
+
+module FastlaneCore
+  class CommanderGenerator
+    include Commander::Methods
+
+    def generate(options)
+      options.each do |option|
+        appendix = (option.is_string ? "STRING" : "")
+        type = (option.is_string ? String : nil)
+        short_option = option.short_option || "-#{option.key.to_s[0]}"
+        global_option short_option, "--#{option.key} #{appendix}", type, (option.description + " (#{option.env_name})")
+      end
+    end
+  end
+end

data/lib/fastlane_core/configuration/config_item.rb

@@ -0,0 +1,69 @@
+module FastlaneCore
+  class ConfigItem
+    attr_accessor :key, :env_name, :description, :short_option, :default_value, :verify_block, :is_string, :optional
+
+    # Creates a new option
+    # @param key (Symbol) the key which is used as command paramters or key in the fastlane tools
+    # @param env_name (String) the name of the environment variable, which is only used if no other values were found
+    # @param description (String) A description shown to the user
+    # @param short_option (String) A string of length 1 which is used for the command parameters (e.g. -f)
+    # @param default_value the value which is used if there was no given values and no environment values
+    # @param verify_block an optional block which is called when a new value is set. 
+    #   Check value is valid. This could be type checks or if a folder/file exists
+    #   You have to raise a specific exception if something goes wrong. Append .red after the string
+    # @param is_string (String) is that parameter a string?
+    # @param optional (Boolean) is false by default. If set to true, also string values will not be asked to the user
+    def initialize(key: nil, env_name: nil, description: nil, short_option: nil, default_value: nil, verify_block: nil, is_string: true, optional: false)
+      raise "key must be a symbol" unless key.kind_of?Symbol
+      raise "env_name must be a String" unless env_name.kind_of?String
+      if short_option
+        raise "short_option must be a String of length 1" unless (short_option.kind_of?String and short_option.gsub('-', '').length == 1)
+      end
+      if description
+        raise "Do not let descriptions end with a '.', since it's used for user inputs as well".red if (description[-1] == '.')
+      end
+
+      @key = key
+      @env_name = env_name
+      @description = description
+      @short_option = short_option
+      @default_value = default_value
+      @verify_block = verify_block
+      @is_string = is_string
+      @optional = optional
+    end
+
+
+    # This will raise an exception if the value is not valid
+    def verify!(value)
+      raise "Invalid value '#{value}' for option '#{self}'".red unless is_valid?value
+      true
+    end
+
+    # Make sure, the value is valid (based on the verify block)
+    # Returns false if that's not the case
+    def is_valid?(value)
+      # we also allow nil values, which do not have to be verified. 
+      if value
+        if @is_string
+          raise "Please pass a path as String".red unless value.kind_of?String
+        end
+        
+        if @verify_block
+          begin
+            @verify_block.call(value)
+          rescue Exception => ex
+            Helper.log.fatal "Error setting value '#{value}' for option '#{@key}'".red
+            raise ex
+          end
+        end
+      end
+
+      true
+    end
+
+    def to_s
+      [@key, @description].join(": ")
+    end
+  end
+end

data/lib/fastlane_core/helper.rb

@@ -53,6 +53,12 @@ module FastlaneCore
       self.test?
     end
 
+    # @return true if building in a known CI environment
+    def self.is_ci?
+      # Check for Jenkins or Travis CI environment variables
+      ENV.has_key?("JENKINS_URL") || ENV.has_key?("TRAVIS")
+    end
+
     # @return the full path to the Xcode developer tools of the currently
     #  running system
     def self.xcode_path

data/lib/fastlane_core/version.rb

@@ -1,3 +1,3 @@
 module FastlaneCore
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane_core
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Felix Krause
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-28 00:00:00.000000000 Z
+date: 2015-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -258,6 +258,9 @@ files:
 - LICENSE
 - README.md
 - lib/fastlane_core.rb
+- lib/fastlane_core/configuration.rb
+- lib/fastlane_core/configuration/commander_generator.rb
+- lib/fastlane_core/configuration/config_item.rb
 - lib/fastlane_core/developer_center/developer_center.rb
 - lib/fastlane_core/developer_center/developer_center_helper.rb
 - lib/fastlane_core/developer_center/developer_center_login.rb
@@ -269,7 +272,7 @@ files:
 - lib/fastlane_core/languages.rb
 - lib/fastlane_core/update_checker.rb
 - lib/fastlane_core/version.rb
-homepage: http://fastlane.tools
+homepage: https://fastlane.tools
 licenses:
 - MIT
 metadata: {}