prepare 5.1.0 release (#219)

## [5.1.0] - 2020-08-04

### Added
- The ability to specify additional headers to be included on HTTP requests to LaunchDarkly services using `LDConfig.additionalHeaders`. This feature is to enable certain proxy configurations, and is not needed for normal use.
- Support for building docs with [jazzy](https://github.com/realm/jazzy). These docs will be available through [GitHub Pages](https://launchdarkly.github.io/ios-client-sdk/).
### Fixed
- SDK causing nested bundles in archived product when including the SDK through Carthage. This caused rejections when submitted to the App Store. Thanks to @spr for reporting ([#217](#217)).
- SDK causing application to expect LDSwiftEventSource dynamic framework when built with SwiftPM, which does not include the dynamic framework in the resulting application. This causes the application to be rejected when submitted to the App Store. Thanks to @spr for reporting ([#216](#216)).

.circleci/config.yml

@@ -55,6 +55,12 @@ jobs:
         command: swift test -v 2>&1 | tee 'artifacts/raw-logs-swiftpm.txt' | xcpretty -r junit -o 'test-results/swiftpm/junit.xml'
         when: always
 
+    - run:
+        name: Build Documentation
+        command: |
+          sudo gem install jazzy
+          jazzy -o artifacts/docs
+
     - run:
         name: CocoaPods spec lint
         command: |

.jazzy.yaml

@@ -1,75 +1,64 @@
 module: LaunchDarkly
 author: LaunchDarkly
-author_url: http://launchdarkly.com
+author_url: https://launchdarkly.com
 github_url: https://github.com/launchdarkly/ios-client-sdk
 clean: true
-include:
-  - "LaunchDarkly/LaunchDarkly/**"
-exclude:
-  - "LaunchDarkly/LaunchDarkly/User/CacheableUserFlags.swift"
-  - "LaunchDarkly/LaunchDarkly/FeatureFlag/*"
-  - "LaunchDarkly/LaunchDarkly/FeatureFlag/FlagChange/Flag*"
-  - "LaunchDarkly/LaunchDarkly/FeatureFlag/FlagRequestTracking/*"
-  - "LaunchDarkly/LaunchDarkly/FeatureFlag/FlagValue/*"
-  - "LaunchDarkly/LaunchDarkly/ServiceObjects/*"
-  - "LaunchDarkly/LaunchDarkly/Networking/*"
-  - "LaunchDarkly/LaunchDarkly/Extensions/*"
+swift_build_tool: spm
+readme: README.md
+documentation:
+  - CHANGELOG.md
+  - CONTRIBUTING.md
+  - LICENSE.txt
 
 copyright: 'Copyright © 2019 Catamorphic Co.'
 
-theme: fullwidth
-
 custom_categories:
-  - name: LaunchDarkly
+  - name: Core Classes
     children:
     - LDClient
     - LDConfig
     - LDUser
-    - LDFlagKey
-
-  - name: Enumerations
-    children:
-    - LDStreamingMode
-    - LDFlagValueSource
-    - LDFlagValue
+    - LDEvaluationDetail
 
-  - name: Flag Changes
+  - name: Flag Change Observers
     children:
+    - LDObserverOwner
     - LDChangedFlag
-    - LDFlagChangeOwner
     - LDFlagChangeHandler
     - LDFlagCollectionChangeHandler
     - LDFlagsUnchangedHandler
-    - LDErrorHandler
 
-  - name: LD Protocols
+  - name: Connection Information
+    children:
+    - ConnectionInformation
+    - LDConnectionModeChangedHandler
+
+  - name: Other Types
     children:
+    - LDStreamingMode
     - LDFlagValueConvertible
+    - LDFlagKey
+    - LDInvalidArgumentError
+    - LDErrorHandler
 
-  - name: Objective-C
+  - name: Objective-C Core Interfaces
     children:
     - ObjcLDClient
     - ObjcLDConfig
     - ObjcLDUser
+    - ObjcLDChangedFlag
 
-  - name: Obj-C Enumerations
-    children:
-    - ObjcLDFlagValue
-    - ObjcLDFlagValueSource
-    - NSString
-
-  - name: Obj-C Variation Values
+  - name: Objective-C EvaluationDetail Wrappers
     children:
-    - ObjcLDBoolVariationValue
-    - ObjcLDIntegerVariationValue
-    - ObjcLDDoubleVariationValue
-    - ObjcLDStringVariationValue
-    - ObjcLDArrayVariationValue
-    - ObjcLDDictionaryVariationValue
+    - ObjcLDBoolEvaluationDetail
+    - ObjcLDIntegerEvaluationDetail
+    - ObjcLDDoubleEvaluationDetail
+    - ObjcLDStringEvaluationDetail
+    - ObjcLDArrayEvaluationDetail
+    - ObjcLDDictionaryEvaluationDetail
 
-  - name: Obj-C Changed Flags
+  - name: Objective-C ChangedFlag Wrappers
     children:
-    - ObjcLDChangedFlag
     - ObjcLDBoolChangedFlag
     - ObjcLDIntegerChangedFlag
     - ObjcLDDoubleChangedFlag

.swiftlint.yml

@@ -1,61 +1,52 @@
-disabled_rules: # rule identifiers to exclude from running
+# See test subconfiguration at `LaunchDarkly/LaunchDarklyTests/.swiftlint.yml`
+
+disabled_rules:
   - line_length
   - trailing_whitespace
-  - todo # temporarily disabled. In general they should be treated as warnings
-#   - type_body_length # temporarily disabled.
-#   - file_length # temporarily disabled
-  - statement_position # wish we could support both uncuddled_else and default (but not others)
-  - trailing_comma
-  - syntactic_sugar
-  - redundant_optional_initialization
-  - redundant_void_return
-  - large_tuple # this is flagging closure argument declarations, seems like a mistake
 
-opt_in_rules: # some rules are only opt-in
+opt_in_rules:
+  - contains_over_filter_count
+  - contains_over_filter_is_empty
+  - contains_over_first_not_nil
+  - contains_over_range_nil_comparison
   - empty_count
-  # - missing_docs
-  # - force_unwrapping
-  # Find all the available rules by running:
-  # swiftlint rules
+  - first_where
+  - flatmap_over_map_reduce
+  - implicitly_unwrapped_optional
+  - let_var_whitespace
+  - missing_docs
+  - redundant_nil_coalescing
+  - sorted_first_last
+  - trailing_closure
+  - unused_declaration
+  - unused_import
+  - vertical_whitespace_closing_braces
 
 included:
   - LaunchDarkly/LaunchDarkly
   - LaunchDarkly/LaunchDarklyTests
 
-excluded: # paths to ignore during linting. Takes precedence over `included`.
-
-# configurable rules can be customized from this configuration file
-# binary rules can set their severity level
-
-# force_cast: warning # implicitly
-# force_try:
-#   severity: warning # explicitly
-# # rules that have both warning and error levels, can set just the warning level
-# # implicitly
-# # line_length: 110
-# # they can set both implicitly with an array
-#
-
-# Set doesn't have isEmpty so using count seems to be our ownly option
-empty_count: warning
+excluded:
 
 function_body_length:
   warning: 50
   error: 70
+
 type_body_length:
-  - 300 # warning
-  - 500 # error
-# or they can set both explicitly
+  warning: 300
+  error: 500
+
 file_length:
   warning: 1000
   error: 1500
+
 identifier_name:
   min_length: # only min_length
     warning: 3 # only warning
-  max_length: # warning and error
+  max_length:
     warning: 50
     error: 60
-  excluded: # excluded via string array
+  excluded:
     - id
     - URL
     - url
@@ -65,4 +56,5 @@ identifier_name:
     - tag
     - lhs
     - rhs
-reporter: "xcode" # reporter type (xcode, json, csv, checkstyle)
+
+reporter: "xcode"

CHANGELOG.md

@@ -2,6 +2,15 @@
 
 All notable changes to the LaunchDarkly iOS SDK will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org).
 
+## [5.1.0] - 2020-08-04
+
+### Added
+- The ability to specify additional headers to be included on HTTP requests to LaunchDarkly services using `LDConfig.additionalHeaders`. This feature is to enable certain proxy configurations, and is not needed for normal use.
+- Support for building docs with [jazzy](https://github.com/realm/jazzy). These docs will be available through [GitHub Pages](https://launchdarkly.github.io/ios-client-sdk/).
+### Fixed
+- SDK causing nested bundles in archived product when including the SDK through Carthage. This caused rejections when submitted to the App Store. Thanks to @spr for reporting ([#217](https://github.com/launchdarkly/ios-client-sdk/issues/217)).
+- SDK causing application to expect LDSwiftEventSource dynamic framework when built with SwiftPM, which does not include the dynamic framework in the resulting application. This causes the application to be rejected when submitted to the App Store. Thanks to @spr for reporting ([#216](https://github.com/launchdarkly/ios-client-sdk/issues/216)).
+
 ## [5.0.1] - 2020-07-23
 **Note that this release contains the notes for the 5.0.0 release, which should not be used.**
 

LaunchDarkly.podspec

@@ -2,7 +2,7 @@
 Pod::Spec.new do |ld|
 
   ld.name         = "LaunchDarkly"
-  ld.version      = "5.0.1"
+  ld.version      = "5.1.0"
   ld.summary      = "iOS SDK for LaunchDarkly"
 
   ld.description  = <<-DESC