diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md index f56159c..e1081f1 100644 --- a/README.md +++ b/README.md @@ -8,18 +8,14 @@ Zero dependency platform detection library for gleam gleam add platform@1 ``` ```gleam +import gleam/io import platform pub fn main() { - // TODO: An example of the project in use + io.debug(platform.runtime()) // Erlang, Node, Deno, Bun, Browser + io.debug(platform.arch()) // X86, X64, Arm, Arm64 + io.debug(platform.os()) // Win32, Linux, Darwin, FreeBsd, OpenBsd } ``` Further documentation can be found at . - -## Development - -```sh -gleam run # Run the project -gleam test # Run the tests -``` diff --git a/examples/simple_demo/.github/workflows/test.yml b/examples/simple_demo/.github/workflows/test.yml new file mode 100644 index 0000000..06d00ad --- /dev/null +++ b/examples/simple_demo/.github/workflows/test.yml @@ -0,0 +1,23 @@ +name: test + +on: + push: + branches: + - master + - main + pull_request: + +jobs: + test: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: erlef/setup-beam@v1 + with: + otp-version: "26.0.2" + gleam-version: "1.4.1" + rebar3-version: "3" + # elixir-version: "1.15.4" + - run: gleam deps download + - run: gleam test + - run: gleam format --check src test diff --git a/examples/simple_demo/.gitignore b/examples/simple_demo/.gitignore new file mode 100644 index 0000000..599be4e --- /dev/null +++ b/examples/simple_demo/.gitignore @@ -0,0 +1,4 @@ +*.beam +*.ez +/build +erl_crash.dump diff --git a/examples/simple_demo/README.md b/examples/simple_demo/README.md new file mode 100644 index 0000000..fd1bae2 --- /dev/null +++ b/examples/simple_demo/README.md @@ -0,0 +1,24 @@ +# simple_demo + +[![Package Version](https://img.shields.io/hexpm/v/simple_demo)](https://hex.pm/packages/simple_demo) +[![Hex Docs](https://img.shields.io/badge/hex-docs-ffaff3)](https://hexdocs.pm/simple_demo/) + +```sh +gleam add simple_demo@1 +``` +```gleam +import simple_demo + +pub fn main() { + // TODO: An example of the project in use +} +``` + +Further documentation can be found at . + +## Development + +```sh +gleam run # Run the project +gleam test # Run the tests +``` diff --git a/examples/simple_demo/gleam.toml b/examples/simple_demo/gleam.toml new file mode 100644 index 0000000..c82572a --- /dev/null +++ b/examples/simple_demo/gleam.toml @@ -0,0 +1,20 @@ +name = "simple_demo" +version = "1.0.0" + +# Fill out these fields if you intend to generate HTML documentation or publish +# your project to the Hex package manager. +# +# description = "" +# licences = ["Apache-2.0"] +# repository = { type = "github", user = "", repo = "" } +# links = [{ title = "Website", href = "" }] +# +# For a full reference of all the available options, you can have a look at +# https://gleam.run/writing-gleam/gleam-toml/. + +[dependencies] +gleam_stdlib = ">= 0.34.0 and < 2.0.0" +platform = { path = "../.."} + +[dev-dependencies] +gleeunit = ">= 1.0.0 and < 2.0.0" diff --git a/examples/simple_demo/manifest.toml b/examples/simple_demo/manifest.toml new file mode 100644 index 0000000..961a9f5 --- /dev/null +++ b/examples/simple_demo/manifest.toml @@ -0,0 +1,13 @@ +# This file was generated by Gleam +# You typically do not need to edit this file + +packages = [ + { name = "gleam_stdlib", version = "0.40.0", build_tools = ["gleam"], requirements = [], otp_app = "gleam_stdlib", source = "hex", outer_checksum = "86606B75A600BBD05E539EB59FABC6E307EEEA7B1E5865AFB6D980A93BCB2181" }, + { name = "gleeunit", version = "1.2.0", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "gleeunit", source = "hex", outer_checksum = "F7A7228925D3EE7D0813C922E062BFD6D7E9310F0BEE585D3A42F3307E3CFD13" }, + { name = "platform", version = "1.0.0", build_tools = ["gleam"], requirements = [], source = "local", path = "../.." }, +] + +[requirements] +gleam_stdlib = { version = ">= 0.34.0 and < 2.0.0" } +gleeunit = { version = ">= 1.0.0 and < 2.0.0" } +platform = { path = "../.." } diff --git a/examples/simple_demo/src/simple_demo.gleam b/examples/simple_demo/src/simple_demo.gleam new file mode 100644 index 0000000..147523d --- /dev/null +++ b/examples/simple_demo/src/simple_demo.gleam @@ -0,0 +1,8 @@ +import gleam/io +import platform + +pub fn main() { + io.debug(platform.runtime()) + io.debug(platform.arch()) + io.debug(platform.os()) +} diff --git a/examples/simple_demo/test/simple_demo_test.gleam b/examples/simple_demo/test/simple_demo_test.gleam new file mode 100644 index 0000000..3831e7a --- /dev/null +++ b/examples/simple_demo/test/simple_demo_test.gleam @@ -0,0 +1,12 @@ +import gleeunit +import gleeunit/should + +pub fn main() { + gleeunit.main() +} + +// gleeunit test functions end in `_test` +pub fn hello_world_test() { + 1 + |> should.equal(1) +} diff --git a/gleam.toml b/gleam.toml index 38dad8e..9c88811 100644 --- a/gleam.toml +++ b/gleam.toml @@ -12,8 +12,5 @@ repository = { type = "github", user = "ditherwither", repo = "platform" } # For a full reference of all the available options, you can have a look at # https://gleam.run/writing-gleam/gleam-toml/. -[dependencies] -gleam_stdlib = ">= 0.34.0 and < 2.0.0" - [dev-dependencies] gleeunit = ">= 1.0.0 and < 2.0.0" diff --git a/manifest.toml b/manifest.toml index e851620..b972e0e 100644 --- a/manifest.toml +++ b/manifest.toml @@ -7,5 +7,4 @@ packages = [ ] [requirements] -gleam_stdlib = { version = ">= 0.34.0 and < 2.0.0" } gleeunit = { version = ">= 1.0.0 and < 2.0.0" } diff --git a/src/platform.gleam b/src/platform.gleam index 1b5101d..2d10e59 100644 --- a/src/platform.gleam +++ b/src/platform.gleam @@ -1,6 +1,3 @@ -import gleam/io -import gleam/string - pub type Runtime { Erlang Node @@ -21,8 +18,6 @@ pub type Os { OtherOs(String) } -// Architecture list from node's docs - pub type Arch { Arm Arm64 @@ -51,6 +46,11 @@ fn os_() -> String @external(javascript, "./platform_ffi.mjs", "arch") fn arch_() -> String +/// Returns the runtime this application is running on +/// +/// On the erlang target, it'll always return `Erlang` +/// +/// On the js target, it'll try to detect the js runtime pub fn runtime() -> Runtime { case runtime_() { "erlang" -> Erlang @@ -62,6 +62,9 @@ pub fn runtime() -> Runtime { } } +/// Returns the host operating system this appication is running on +/// +/// In web browsers, this will always return OtherOs("unknown") pub fn os() -> Os { case os_() { "aix" -> Aix @@ -75,8 +78,17 @@ pub fn os() -> Os { } } +/// Returns the CPU architecture of the host system +/// +/// In web browsers, this will always return OtherArch("unknown") +/// +/// On erlang for windows, it'll always return either X86 or X64, even under a beam vm compiled for arm. +/// This is because there is no simple way to get the cpu archictecture on windows, and it currently uses +/// the bitness of the cpu to guess it instead. +/// +/// As of 22nd August 2024, there are no prebuilt binaries for windows for arm, so this shouldn't matter pub fn arch() -> Arch { - case string.lowercase(arch_()) { + case arch_() { "arm" -> Arm "arm64" | "aarch64" -> Arm64 "x86" | "ia32" -> X86 @@ -92,12 +104,3 @@ pub fn arch() -> Arch { arch -> OtherArch(arch) } } - -pub fn main() { - // io.debug("Runtime") - io.debug(runtime()) - // io.debug("Os") - io.debug(os()) - // io.debug("Arch") - io.debug(arch()) -}