mvp: Merge pull request #6 from mwln/examples-lib

first draft mvp

Author: mwln

.gitignore

@@ -2,9 +2,9 @@
 # will have compiled files and executables
 /target/
 
-# Remove Cargo.lock from gitignore if creating an executable, leave it for libraries
-# More information here https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html
-Cargo.lock
+# wasm default directory
+/pkg/
+*.json
 
 # These are backup files generated by rustfmt
 **/*.rs.bk

Cargo.lock

@@ -1,9 +1,16 @@
 [package]
-name = "noclue"
+name = "puz"
 version = "0.1.0"
 edition = "2021"
 
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+[lib]
+crate-type = ["cdylib", "rlib"]
 
 [dependencies]
-byteorder = "1.3.1"
+wasm-bindgen-futures = "0.4.37"
+wasm-bindgen = "0.2.87"
+gloo-file = {version = "0.3.0", features = ['futures'] }
+js-sys = "0.3.64"
+web-sys = { version = "0.3.64", features = ['File', 'FileReader', 'Blob', 'console'] }
+byteorder = "1.4.3"
+serde_json = "1.0.107"

Cargo.toml

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 mert!
+Copyright (c) 2022 mwln
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

LICENSE

@@ -1,12 +1,13 @@
-# noclue
+# puz.rs
+
 A .puz file parser
 
 ## Usage
 
-* Takes in one or more `.puz` files and parses them to TOML format on stdout
-* assigns a "smartId", as a means of identifying unique puzzles based on 
+- Takes in one or more `.puz` files and parses them to TOML format on stdout
+- assigns a "smartId", as a means of identifying unique puzzles based on
   solution grid.
-* Can return the following to stdout / file(s) / or through a module function via
+- Can return the following to stdout / file(s) / or through a module function via
   crate import:
 
 ```toml
@@ -28,8 +29,8 @@ solution = [
 ]
 extensions = [
     # nothing here means puzzle is standard
-    # circled squares = o 
-    # tile contents are given = g 
+    # circled squares = o
+    # tile contents are given = g
     # tile has rebus @ index n = n (`u16`)
     "og3", # circled, contents given, rebus.options[3]
     "...",
@@ -54,11 +55,10 @@ options = [ "CLUB", "DIAMOND", "SPADE", "HEARTS"]
 
 ## Thoughts
 
-* Think of ways to handle multiple files when outputting to stdout
+- Think of ways to handle multiple files when outputting to stdout
 
 ## Considerations
 
-* How do scrambled puzzles get read?
-* Assigning rebus's properly
-* GEXT analysis for board setup
-
+- How do scrambled puzzles get read?
+- Assigning rebus's properly
+- GEXT analysis for board setup

README.md

@@ -0,0 +1,22 @@
+use puz::parse_puz;
+use std::{
+    fs::File,
+    io::{ErrorKind, Write},
+};
+fn main() -> std::io::Result<()> {
+    let path = "examples/data/rebus.puz";
+    let file = match File::open(&path) {
+        Err(err) => match err.kind() {
+            ErrorKind::NotFound => panic!("File not found at path: {}", &path),
+            other_error => panic!("Problem opening the file: {:?}", other_error),
+        },
+        Ok(file) => file,
+    };
+
+    let puzzle = parse_puz(&file).expect("Error while parsing the file.");
+    let file_path = "examples/output.json";
+    let mut file = File::create(file_path)?;
+    file.write_all(puzzle.to_string().as_bytes())?;
+
+    Ok(())
+}