Merge pull request #68 from gumob:develop

Develop
gumob · Aug 27, 2024 · 0887fdb · 0887fdb
2 parents cc3d4a6 + d1bd3e4
commit 0887fdb
Show file tree

Hide file tree

Showing 55 changed files with 7,802 additions and 88 deletions.
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -14,7 +14,7 @@ on:
       - Package.swift
       - Punycode.podspec
       - Punycode.xcodeproj/**
-      - Source/**
+      - Sources/**
       - Tests/**
   # pull_request:
   #   branches:
@@ -28,7 +28,7 @@ on:
   #     - Package.swift
   #     - Punycode.podspec
   #     - Punycode.xcodeproj/**
-  #     - Source/**
+  #     - Sources/**
   #     - Tests/**
 
 concurrency:

diff --git a/.jazzy.yml b/.jazzy.yml
@@ -0,0 +1,31 @@
+module: Punycode
+version: 3.0.0
+
+author: Kojiro Futamura
+author_url: https://github.com/gumob
+github_url: https://github.com/gumob/PunycodeSwift
+# copyright: 'Copyright © 2024 Kojiro Futamura. All rights reserved.'
+
+source_host_url: https://github.com/gumob/PunycodeSwift
+root_url: https://github.com/gumob/PunycodeSwift/tree/3.0.0/docs/
+
+readme: "README.md"
+
+theme: fullwidth
+
+xcodebuild_arguments:
+  - -project
+  - ../Punycode.xcodeproj
+  - -scheme
+  - Punycode
+
+output: "docs/swiftdoc"
+min_acl: public
+clean: true
+skip_undocumented: false
+hide_documentation_coverage: true
+source_directory: Sources
+umbrella_header: "Sources/Punycode.h"
+
+exclude:
+  - Tests/*
diff --git a/.swiftlint.yml b/.swiftlint.yml
@@ -6,7 +6,7 @@ line_length: 960
 function_body_length: 100
 
 excluded:
-  - Source/SPMPSL.swift
+  - Sources/SPMPSL.swift
   - Tests
   - Carthage
   - Pods

diff --git a/Gemfile b/Gemfile
@@ -7,9 +7,9 @@ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 gem "cocoapods"
 gem "cocoapods-deintegrate"
 gem "cocoapods-clean"
-gem "travis"
 gem "fastlane"
 gem "slather"
+gem "jazzy"
 gem "xcpretty"
 
 plugins_path = File.join(File.dirname(__FILE__), 'fastlane', 'Pluginfile')

diff --git a/Gemfile.lock b/Gemfile.lock
@@ -5,11 +5,17 @@ GEM
       base64
       nkf
       rexml
-    activesupport (5.2.8.1)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
+    activesupport (7.2.1)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.3.1)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
+      minitest (>= 5.1)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
     addressable (2.8.7)
       public_suffix (>= 2.0.2, < 7.0)
     algoliasearch (1.27.5)
@@ -35,6 +41,7 @@ GEM
       aws-eventstream (~> 1, >= 1.0.2)
     babosa (1.0.4)
     base64 (0.2.0)
+    bigdecimal (3.1.8)
     claide (1.1.0)
     clamp (1.3.2)
     cocoapods (1.15.2)
@@ -80,11 +87,13 @@ GEM
     commander (4.6.0)
       highline (~> 2.0.0)
     concurrent-ruby (1.3.4)
+    connection_pool (2.4.1)
     declarative (0.0.20)
     digest-crc (0.6.5)
       rake (>= 12.0.0, < 14.0.0)
     domain_name (0.6.20240107)
     dotenv (2.8.1)
+    drb (2.2.1)
     emoji_regex (3.2.3)
     escape (0.0.4)
     ethon (0.16.0)
@@ -173,14 +182,6 @@ GEM
     ffi (1.17.0-x86_64-linux-musl)
     fourflusher (2.3.1)
     fuzzy_match (2.0.4)
-    gh (0.18.0)
-      activesupport (~> 5.0)
-      addressable (~> 2.4)
-      faraday (~> 1.0)
-      faraday_middleware (~> 1.0)
-      multi_json (~> 1.0)
-      net-http-persistent (~> 2.9)
-      net-http-pipeline
     gh_inspector (1.1.3)
     google-apis-androidpublisher_v3 (0.54.0)
       google-apis-core (>= 0.11.0, < 2.a)
@@ -224,24 +225,32 @@ GEM
     httpclient (2.8.3)
     i18n (1.14.5)
       concurrent-ruby (~> 1.0)
+    jazzy (0.15.1)
+      cocoapods (~> 1.5)
+      mustache (~> 1.1)
+      open4 (~> 1.3)
+      redcarpet (~> 3.4)
+      rexml (>= 3.2.7, < 4.0)
+      rouge (>= 2.0.6, < 5.0)
+      sassc (~> 2.1)
+      sqlite3 (~> 1.3)
+      xcinvoke (~> 0.3.0)
     jmespath (1.6.2)
     json (2.7.2)
-    json_pure (2.7.2)
     jwt (2.8.2)
       base64
-    launchy (2.4.3)
-      addressable (~> 2.3)
+    liferaft (0.0.6)
+    logger (1.6.0)
     mini_magick (4.13.2)
     mini_mime (1.1.5)
     minitest (5.25.1)
     molinillo (0.8.0)
     multi_json (1.15.0)
     multipart-post (2.4.1)
+    mustache (1.1.1)
     nanaimo (0.3.0)
     nap (1.1.0)
     naturally (2.2.1)
-    net-http-persistent (2.9.4)
-    net-http-pipeline (1.0.1)
     netrc (0.11.0)
     nkf (0.2.0)
     nokogiri (1.16.7-aarch64-linux)
@@ -256,15 +265,14 @@ GEM
       racc (~> 1.4)
     nokogiri (1.16.7-x86_64-linux)
       racc (~> 1.4)
+    open4 (1.3.4)
     optparse (0.5.0)
     os (1.1.4)
     plist (3.7.1)
     public_suffix (4.0.7)
-    pusher-client (0.6.2)
-      json
-      websocket (~> 1.0)
     racc (1.8.1)
     rake (13.2.1)
+    redcarpet (3.6.0)
     representable (3.2.0)
       declarative (< 0.1.0)
       trailblazer-option (>= 0.1.1, < 0.2.0)
@@ -276,6 +284,9 @@ GEM
     ruby-macho (2.5.1)
     ruby2_keywords (0.0.5)
     rubyzip (2.3.2)
+    sassc (2.4.0)
+      ffi (~> 1.9)
+    securerandom (0.3.1)
     security (0.1.5)
     signet (0.19.0)
       addressable (~> 2.8)
@@ -291,32 +302,30 @@ GEM
       clamp (~> 1.3)
       nokogiri (>= 1.14.3)
       xcodeproj (~> 1.21)
+    sqlite3 (1.7.3-aarch64-linux)
+    sqlite3 (1.7.3-arm-linux)
+    sqlite3 (1.7.3-arm64-darwin)
+    sqlite3 (1.7.3-x86-linux)
+    sqlite3 (1.7.3-x86_64-darwin)
+    sqlite3 (1.7.3-x86_64-linux)
     strscan (3.1.0)
     terminal-notifier (2.0.0)
     terminal-table (3.0.2)
       unicode-display_width (>= 1.1.1, < 3)
-    thread_safe (0.3.6)
     trailblazer-option (0.1.2)
-    travis (1.11.1)
-      faraday (~> 1.0)
-      faraday_middleware (~> 1.0)
-      gh (~> 0.13)
-      highline (~> 2.0)
-      json_pure (~> 2.3)
-      launchy (~> 2.1, < 2.5.0)
-      pusher-client (~> 0.4)
     tty-cursor (0.7.1)
     tty-screen (0.8.2)
     tty-spinner (0.9.3)
       tty-cursor (~> 0.7)
     typhoeus (1.4.1)
       ethon (>= 0.9.0)
-    tzinfo (1.2.11)
-      thread_safe (~> 0.1)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
     uber (0.1.0)
     unicode-display_width (2.5.0)
-    websocket (1.2.11)
     word_wrap (1.0.0)
+    xcinvoke (0.3.0)
+      liferaft (~> 0.0.6)
     xcodeproj (1.25.0)
       CFPropertyList (>= 2.3.3, < 4.0)
       atomos (~> 0.1.3)
@@ -351,8 +360,8 @@ DEPENDENCIES
   cocoapods-deintegrate
   fastlane
   fastlane-plugin-versioning
+  jazzy
   slather
-  travis
   xcpretty
 
 BUNDLED WITH

diff --git a/Package.swift b/Package.swift
@@ -14,7 +14,7 @@ let package = Package(
         .target(
             name: "Punycode",
             dependencies: [],
-            path: "Source"),
+            path: "Sources"),
         .testTarget(
             name: "PunycodeSwiftTests",
             dependencies: ["Punycode"],

diff --git a/Punycode.podspec b/Punycode.podspec
@@ -9,7 +9,7 @@ Pod::Spec.new do |s|
   s.frameworks                 = 'Foundation'
   s.requires_arc               = true
   s.source                     = { :git => "https://github.com/gumob/PunycodeSwift.git", :tag => "#{s.version}" }
-  s.source_files               = "Source/*.{swift}"
+  s.source_files               = "Sources/*.{swift}"
   s.osx.deployment_target      = "10.13"
   s.ios.deployment_target      = "12.0"
   s.tvos.deployment_target     = "12.0"

diff --git a/Punycode.xcodeproj/project.pbxproj b/Punycode.xcodeproj/project.pbxproj
@@ -57,7 +57,7 @@
 		A75359A52C7ABA7C00564274 = {
 			isa = PBXGroup;
 			children = (
-				A75359B12C7ABA7C00564274 /* Source */,
+				A75359B12C7ABA7C00564274 /* Sources */,
 				A75359BB2C7ABA7D00564274 /* Tests */,
 				A75359B02C7ABA7C00564274 /* Products */,
 			);
@@ -72,15 +72,15 @@
 			name = Products;
 			sourceTree = "<group>";
 		};
-		A75359B12C7ABA7C00564274 /* Source */ = {
+		A75359B12C7ABA7C00564274 /* Sources */ = {
 			isa = PBXGroup;
 			children = (
 				A75359B22C7ABA7C00564274 /* Punycode.h */,
 				A745A09F2C7ABB7C005625EF /* Punycode.swift */,
 				A745A09E2C7ABB7C005625EF /* Extensions.swift */,
 				A745A0A02C7ABB7C005625EF /* Helpers.swift */,
 			);
-			path = Source;
+			path = Sources;
 			sourceTree = "<group>";
 		};
 		A75359BB2C7ABA7D00564274 /* Tests */ = {
@@ -215,7 +215,7 @@
 			);
 			runOnlyForDeploymentPostprocessing = 0;
 			shellPath = /bin/zsh;
-			shellScript = "export PATH=\"$PATH:/opt/homebrew/bin\"\n\nif which swift-format >/dev/null; then\n    swift-format format --in-place --ignore-unparsable-files --configuration .swift-format --recursive Source Tests || true\n    swift-format lint --ignore-unparsable-files --configuration .swift-format --recursive Source Tests || true\nelse\n    echo \"warning: swift-format not installed\"\nfi\n";
+			shellScript = "export PATH=\"$PATH:/opt/homebrew/bin\"\n\nif which swift-format >/dev/null; then\n    swift-format format --in-place --ignore-unparsable-files --configuration .swift-format --recursive Sources Tests || true\n    swift-format lint --ignore-unparsable-files --configuration .swift-format --recursive Sources Tests || true\nelse\n    echo \"warning: swift-format not installed\"\nfi\n";
 		};
 /* End PBXShellScriptBuildPhase section */
 

diff --git a/README.md b/README.md
@@ -29,33 +29,63 @@ Punycode is a representation of Unicode with the limited ASCII character subset
 
 Add the following to your `Package.swift` file.
 
-```swift
-dependencies: [
-    .package(url: "https://github.com/gumob/PunycodeSwift.git", .upToNextMajor(from: "3.0.0"))
-]
-```
+- macOS, iOS, tvOS, watchOS, visionOS, and Swift 5
+    ```swift
+    dependencies: [
+        .package(url: "https://github.com/gumob/PunycodeSwift.git", .upToNextMajor(from: "3.0.0"))
+    ]
+    ```
+
+- macOS, iOS, tvOS, and Swift 5
+    ```swift
+    dependencies: [
+        .package(url: "https://github.com/gumob/PunycodeSwift.git", .upToNextMajor(from: "2.1.1"))
+    ]
+    ```
 
 ### Carthage
 
 Add the following to your `Cartfile` and follow [these instructions](https://github.com/Carthage/Carthage#adding-frameworks-to-an-application).
 
-```Certfile
-github "gumob/PunycodeSwift"          # Latest (Swift 5.0)
-github "gumob/PunycodeSwift" ~> 3.0   # Swift 5.0
-github "gumob/PunycodeSwift" ~> 2.2   # Swift 5.0
-github "gumob/PunycodeSwift" ~> 1.0   # Swift 4.2
-```
+- macOS, iOS, tvOS, watchOS, visionOS, and Swift 5
+
+    ```
+    github "gumob/PunycodeSwift" ~> 3.0
+    ```
+
+- macOS, iOS, tvOS, and Swift 5
+
+    ```
+    github "gumob/PunycodeSwift" ~> 2.0
+    ```
+
+- macOS, iOS, tvOS, and Swift 4
+
+    ```
+    github "gumob/PunycodeSwift" ~> 1.0
+    ```
 
 ### CocoaPods
 
-To integrate Punycode into your project, add the following to your `Podfile`.
+To integrate TLDExtract into your project, add the following to your `Podfile`.
 
-```ruby
-pod 'Punycode'             # Latest (Swift 5.0)
-pod 'Punycode', '~> 3.0'   # Swift 5.0
-pod 'Punycode', '~> 2.2'   # Swift 5.0
-pod 'Punycode', '~> 1.0'   # Swift 4.2
-```
+- macOS, iOS, tvOS, watchOS, visionOS, and Swift 5.0
+
+    ```ruby
+    pod 'Punycode', '~> 3.0'
+    ```
+
+- macOS, iOS, tvOS, and Swift 5.0
+
+    ```ruby
+    pod 'Punycode', '~> 2.0'
+    ```
+
+- macOS, iOS, tvOS, and Swift 4.2
+
+    ```ruby
+    pod 'Punycode', '~> 1.0'
+    ```
 
 ## Usage