v2.1.0 (#67)

* [#63] Added support for installation via CocoaPods (#64) * [#65] Removed redundant Linux test manifest (#66) * Updated `import`s in tests * Updated docs title in Jazzy configuration
yakovmanshin · May 17, 2021 · cb10623 · cb10623
2 parents 4484369 + ab188c0
commit cb10623
Show file tree

Hide file tree

Showing 18 changed files with 98 additions and 104 deletions.
diff --git a/.github/workflows/spm-ci.yml → .github/workflows/run-tests.yml b/.github/workflows/spm-ci.yml → .github/workflows/run-tests.yml
@@ -1,20 +1,28 @@
-name: SPM CI
+name: Run Tests
 
 on: [pull_request, push]
 
 jobs:
-  macos-test:
+
+  spm-macos-test:
     runs-on: macos-11.0
     steps:
     - uses: actions/checkout@v2
     - name: Select Xcode version
       run: sudo xcode-select -switch /Applications/Xcode_12.5.app
     - name: Run tests
       run: swift test -v
-
-  linux-test:
+  
+  spm-linux-test:
     runs-on: ubuntu-20.04
     steps:
     - uses: actions/checkout@v2
     - name: Run tests
       run: swift test -v
+
+  cocoapods-podspec-lint:
+    runs-on: macos-11.0
+    steps:
+    - uses: actions/checkout@v2
+    - name: Lint Podspec
+      run: pod lib lint --verbose
diff --git a/.jazzy.yaml b/.jazzy.yaml
@@ -24,5 +24,5 @@ disable_search: true
 github_file_prefix: https://github.com/yakovmanshin/YMFF/tree/main
 github_url: https://github.com/yakovmanshin/YMFF
 hide_documentation_coverage: true
-title: YMFF Docs
+title: YMFF v2 Docs
 undocumented_text: Documentation Coming Soon…
diff --git a/README.md b/README.md
@@ -9,6 +9,8 @@ YMFF is a nice little library that makes management of features with feature fla
 YMFF ships completely ready for use, right out of the box: you get everything you need to start in just a few minutes. But you can also replace nearly any component of the system with your own, customized implementation. Since version 2.0, the implementation and the protocols are in two separate targets (YMFF and YMFFProtocols, respectively).
 
 ## Installation
+
+### Swift Package Manager (SPM)
 To add YMFF to your project, use Xcode’s built-in support for Swift packages. Click File → Swift Packages → Add Package Dependency, and paste the following URL into the search field:
 
 ```
@@ -23,6 +25,15 @@ If you need to use YMFF in another Swift package, add it as a dependency:
 .package(url: "https://github.com/yakovmanshin/YMFF", .upToNextMajor(from: "2.0.0"))
 ```
 
+### CocoaPods
+YMFF now supports installation via [CocoaPods](https://youtu.be/iEAjvNRdZa0).
+
+Add the following to your Podfile:
+
+```ruby
+pod 'YMFF', '~> 2.1'
+```
+
 ## Setup
 All you need to start managing features with YMFF is at least one feature flag *store*—an object which conforms to `FeatureFlagStoreProtocol` and provides values that correspond to feature flag keys.
 

diff --git a/Sources/YMFF/FeatureFlag/FeatureFlag.swift b/Sources/YMFF/FeatureFlag/FeatureFlag.swift
@@ -6,7 +6,9 @@
 //  Copyright © 2020 Yakov Manshin. See the LICENSE file for license info.
 //
 
+#if !COCOAPODS
 import YMFFProtocols
+#endif
 
 /// An object that facilitates access to feature flag values.
 @propertyWrapper

diff --git a/Sources/YMFF/FeatureFlagResolver/Configuration/FeatureFlagResolverConfiguration.swift b/Sources/YMFF/FeatureFlagResolver/Configuration/FeatureFlagResolverConfiguration.swift
@@ -6,7 +6,9 @@
 //  Copyright © 2020 Yakov Manshin. See the LICENSE file for license info.
 //
 
+#if !COCOAPODS
 import YMFFProtocols
+#endif
 
 // MARK: - FeatureFlagResolverConfiguration
 

diff --git a/Sources/YMFF/FeatureFlagResolver/FeatureFlagResolver.swift b/Sources/YMFF/FeatureFlagResolver/FeatureFlagResolver.swift
@@ -6,7 +6,9 @@
 //  Copyright © 2020 Yakov Manshin. See the LICENSE file for license info.
 //
 
+#if !COCOAPODS
 import YMFFProtocols
+#endif
 
 // MARK: - FeatureFlagResolver
 

diff --git a/Sources/YMFF/FeatureFlagResolver/Store/RuntimeOverridesStore.swift b/Sources/YMFF/FeatureFlagResolver/Store/RuntimeOverridesStore.swift
@@ -6,7 +6,9 @@
 //  Copyright © 2020 Yakov Manshin. See the LICENSE file for license info.
 //
 
+#if !COCOAPODS
 import YMFFProtocols
+#endif
 
 // MARK: - RuntimeOverridesStore
 

diff --git a/Sources/YMFF/FeatureFlagResolver/Store/TransparentFeatureFlagStore.swift b/Sources/YMFF/FeatureFlagResolver/Store/TransparentFeatureFlagStore.swift
@@ -6,7 +6,9 @@
 //  Copyright © 2020 Yakov Manshin. See the LICENSE file for license info.
 //
 
+#if !COCOAPODS
 import YMFFProtocols
+#endif
 
 // MARK: - TransparentFeatureFlagStore
 

diff --git a/Sources/YMFF/FeatureFlagResolver/Store/UserDefaultsStore.swift b/Sources/YMFF/FeatureFlagResolver/Store/UserDefaultsStore.swift
@@ -9,7 +9,9 @@
 #if canImport(Foundation)
 
 import Foundation
+#if !COCOAPODS
 import YMFFProtocols
+#endif
 
 // MARK: - UserDefaultsStore
 

diff --git a/Tests/LinuxMain.swift b/Tests/LinuxMain.swift
diff --git a/Tests/YMFFTests/FeatureFlagResolverTests.swift b/Tests/YMFFTests/FeatureFlagResolverTests.swift
@@ -7,7 +7,10 @@
 //
 
 import XCTest
+#if !COCOAPODS
 import YMFFProtocols
+#endif
+
 @testable import YMFF
 
 // MARK: - Configuration

diff --git a/Tests/YMFFTests/FeatureFlagTests.swift b/Tests/YMFFTests/FeatureFlagTests.swift
@@ -7,7 +7,10 @@
 //
 
 import XCTest
+#if !COCOAPODS
 import YMFFProtocols
+#endif
+
 @testable import YMFF
 
 // MARK: - Configuration

diff --git a/Tests/YMFFTests/MutableStoreTests.swift b/Tests/YMFFTests/MutableStoreTests.swift
@@ -7,7 +7,9 @@
 //
 
 import XCTest
+#if !COCOAPODS
 import YMFFProtocols
+#endif
 
 @testable import YMFF
 

diff --git a/Tests/YMFFTests/RuntimeOverridesStoreTests.swift b/Tests/YMFFTests/RuntimeOverridesStoreTests.swift
@@ -7,7 +7,10 @@
 //
 
 import XCTest
+#if !COCOAPODS
 import YMFFProtocols
+#endif
+
 @testable import YMFF
 
 // MARK: - Configuration

diff --git a/Tests/YMFFTests/SharedAssets/SharedAssets.swift b/Tests/YMFFTests/SharedAssets/SharedAssets.swift
@@ -7,7 +7,9 @@
 //
 
 import YMFF
+#if !COCOAPODS
 import YMFFProtocols
+#endif
 
 // MARK: - Shared
 

diff --git a/Tests/YMFFTests/UserDefaultsStoreTests.swift b/Tests/YMFFTests/UserDefaultsStoreTests.swift
@@ -9,6 +9,7 @@
 #if canImport(Foundation)
 
 import XCTest
+
 @testable import YMFF
 
 final class UserDefaultsStoreTests: XCTestCase {

diff --git a/Tests/YMFFTests/XCTestManifests.swift b/Tests/YMFFTests/XCTestManifests.swift
diff --git a/YMFF.podspec b/YMFF.podspec
@@ -0,0 +1,48 @@
+Pod::Spec.new do |s|
+
+  # Basic Info
+
+  s.name              = "YMFF"
+  s.version           = "2.1.0"
+  s.summary           = "Feature management made easy."
+
+  s.description       = <<-DESC
+  YMFF is a nice little library that makes management of features
+  with feature flags—and management of the feature flags themselves—a bliss.
+                        DESC
+
+  s.homepage          = "https://github.com/yakovmanshin/YMFF"
+  s.documentation_url = "https://opensource.ym.dev/YMFF/"
+
+  s.license           = { :type => "Apache License, version 2.0", :file => "LICENSE" }
+
+  s.author            = { "Yakov Manshin" => "[email protected]" }
+  s.social_media_url  = "https://github.com/yakovmanshin"
+
+  # Sources & Build Settings
+
+  s.source            = { :git => "https://github.com/yakovmanshin/YMFF.git", :tag => "#{s.version}" }
+
+  s.swift_version     = "5.3"
+  s.osx.deployment_target     = "10.13"
+  s.ios.deployment_target     = "11.0"
+
+  # Subspecs
+
+  s.default_subspec   = "YMFF"
+
+  s.subspec "YMFF" do |is|
+    is.source_files = "Sources/YMFF/**/*.{swift}"
+    is.dependency "YMFF/YMFFProtocols"
+  end
+
+  s.subspec "YMFFProtocols" do |ps|
+    ps.source_files = "Sources/YMFFProtocols/**/*.{swift}"
+  end
+
+  s.test_spec "Tests" do |ts|
+    ts.source_files = "Tests/YMFFTests/**/*.{swift}"
+    ts.dependency "YMFF/YMFF"
+  end
+
+end