Merge pull request #18 from angular-package/develop

v0.8.0-beta

Author: angularpackage

CHANGELOG.md

@@ -1,5 +1,20 @@
 # @angular-package/sass changelog
 
+### v0.8.0-beta [#](https://github.com/angular-package/sass/releases/tag/v0.8.0-beta)
+
+- Add [`object.destroy()`](https://github.com/angular-package/sass/blob/main/object/_object.destroy.function.scss) to remove object name. [127c5e4]
+- Update [`translator/dictionary`](https://github.com/angular-package/sass/tree/main/translator/v1.0.0/dictionary) module to use `object` module. [ae50b2a]
+- Update [`object.set()`](https://github.com/angular-package/sass/blob/main/object/_object.set.function.scss) function to return `$name` on `$name` equal to it `object.$object`. [3e2f9b8]
+- Add [`object.has-key()`](https://github.com/angular-package/sass/blob/main/object/_object.has-key.function.scss) function to check the key in any object. [25b7bff]
+- Add [`object.get-key()`](https://github.com/angular-package/sass/blob/main/object/_object.get-key.function.scss) function to get key object of `$name` and `$key`. [c05d520] [112747d]
+
+[3e2f9b8]: https://github.com/angular-package/sass/pull/18/commits/3e2f9b8569d98d9f9baa5b1319f62a0ccad58d8a
+[127c5e4]: https://github.com/angular-package/sass/commit/127c5e4235ca08608a7889cc67c6872eea03509f
+[ae50b2a]: https://github.com/angular-package/sass/commit/ae50b2a9cdf76d8791aeebe93ef4c5def16b11c8
+[25b7bff]: https://github.com/angular-package/sass/commit/25b7bff9bfdce8b1399ced485aa015b74f72671f
+[112747d]: https://github.com/angular-package/sass/commit/112747d3b4baeac610f08e7fc0ec22cc7c40d5af
+[c05d520]: https://github.com/angular-package/sass/commit/c05d52067755dfdaf368e16164bb1ba9570592ed
+
 ### v0.7.0-beta [#](https://github.com/angular-package/sass/releases/tag/v0.7.0-beta)
 
 - Fix `map.set()` - add checking whether `$key` is comma-separated list to have ability to add space separated keys. [1d46564]

object/_index.scss

@@ -1,6 +1,9 @@
 @forward 'object.copy.function';
 @forward 'object.create.function';
+@forward 'object.destroy.function';
+@forward 'object.get-key.function';
 @forward 'object.get.function';
+@forward 'object.has-key.function';
 @forward 'object.keys.function';
 @forward 'object.last-id.function';
 @forward 'object.last-name.function';

object/_object.copy.function.scss

@@ -1,22 +1,13 @@
-// Sass.
-@use 'sass:list';
-
-// Variables.
-@use 'object.var' as object;
-
-// Modules.
-@use '../map';
-
 // Functions.
 @use 'object.get.function' as *;
 @use 'object.set.function' as *;
-@use 'object.use.function' as *;
 
 // Status: DONE
-// The `object.copy()` function.
-// @param `$from`
-// @param `$to`
-// @returns
+// The `object.copy()` function copies value from key `$from` to key `$to` of last created or selected object.
+// Copy values of different object names by providing map type (name: key). For example. (dictionary: class).
+// @param `$from` A key which from value is copied to key `$to`.
+// @param `$to` A key under which `$value` is pasted.
+// @returns The returned value is object with copied value from key `$from` to `$to`(if it's the same object).
 @function copy($from, $to) {
   @return set($to, get($from));
 }

object/_object.create.function.scss

@@ -12,8 +12,8 @@
 // Status: DONE
 // The `object.create()` function sets `map` type object in `object.$object` variable under `$name` key.
 // @param `$object` A `map` type value to set in `object.$object` under `$name`.
-// @param `$name` The name under which `$object` of `map` type is stored, `null` indicates add new object under incremented `number`.
-// @returns The returned value is `$object` of `map` type under `$name` key of `object.$object`.
+// @param `$name` The name under which object of `map` type is stored, by default new object is stored under incremented `number`.
+// @returns The returned value is object of `map` type stored under `$name` key of `object.$object`.
 @function create($object, $name: list.length(object.$object) + 1) {
   $object: if(meta.type-of(list) and list.length($object) == 0, map.remove((1:1), 1), $object);
   @if type-of($object) == map {

object/_object.destroy.function.scss

@@ -0,0 +1,22 @@
+// Sass.
+@use 'sass:map';
+
+// Object.
+@use 'object.var' as object;
+
+// Functions.
+@use 'object.get.function' as *;
+@use 'object.last-name.function' as *;
+@use 'object.use.function' as *;
+
+// Status: DONE
+// The `object.destroy()` function removes object(`map`) of `$name`.
+// @param `$name` Object name to remove.
+// @returns The returned value is last created object.
+@function destroy($name: object.$name or last-name()) {
+  @if map.has-key(object.$object, $name) {
+    $debug: use(null);
+    object.$object: map.remove(object.$object, $name);
+  }
+  @return get();
+}

object/_object.get-key.function.scss

@@ -0,0 +1,22 @@
+// Sass.
+@use 'sass:list';
+
+// Object.
+@use 'object.var' as object;
+
+// Functions.
+@use '../list/list.insert-nth.function' as *;
+@use 'object.last-name.function' as *;
+
+// Status: DONE
+// The `object.get-key()` function gets key object of `$name` and `$key`.
+// @param `$name` Object name, by default selected by `object.use()` or last object.
+// @param `$key` A key to retrieve from object of `$name`.
+// @returns The returned value is an object key of `$name` and `$key`.
+@function get-key($name: object.$name or last-name(), $key: null) {
+  @return if(
+    $key,
+    insert-nth(if(list.separator($key) == comma, $key, ($key,)), 1, $name),
+    $name
+  );
+}

object/_object.get.function.scss

@@ -1,28 +1,23 @@
-// Sass.
-@use 'sass:list';
-
 // Object.
 @use 'object.var' as object;
 
 // Modules.
 @use '../map';
 
 // Functions.
-@use 'object.last-name.function' as *;
-@use 'object.use.function' as *;
+@use 'object.get-key.function' as *;
 
 // Status: DONE
-// The `object.get()` function gets `map` from `object.$object` variable of key `$name`, where by default is last created or set by `object.use()`.
-// @param `$key` An optional key of `map` from `object.$object` to get.
+// The `object.get()` function gets object, optionally value of this object retrieved from key.
+// To get the value from different object than in use pass `$key` as map where (name: key).
+// @param `$key` An optional key of object in use to get value, or object with key.
 // @param `$fallback` Fallback value if retrieved is `null`.
-// // @param `$name` A name of `map` in `object.$object` to get, `null` indicates last created object.
-// @returns The returned value is a `map` retrieved from `object.$object` of `$name`, optionally value retrieved from `$key`.
+// @returns The returned value is `map` from variable `object.$object`(optionally value from `$key`), by default from last created or set by `object.use()` object.
 @function get($key: null, $fallback: null) {
-  $name: object.$name or last-name();
   @if type-of($key) == map {
     @each $name, $key in $key {
-      @return map.get(object.$object, list.append($name, $key, comma), $fallback);
+      @return map.get(object.$object, get-key($name, $key), $fallback);
     }
   }
-  @return map.get(object.$object, if($key, list.append($name, $key, comma), $name), $fallback);
+  @return map.get(object.$object, get-key($key: $key), $fallback);
 }

object/_object.has-key.function.scss

@@ -0,0 +1,22 @@
+// Sass.
+@use 'sass:map';
+
+// Variables.
+@use 'object.var' as object;
+
+// Functions.
+@use 'object.get-key.function' as *;
+
+// Status: TODO: key
+// The `object.has-key()` function checks whether object in use has key.
+// @param `$key` Required key to check object in use has.
+// @arbitrary `$keys...` Additional keys to check nested key.
+// @returns The returned value is a `bool` indicating object in use has key.
+@function has-key($key, $keys...) {
+  @if type-of($key) == map {
+    @each $name, $key in $key {
+      @return map.has-key(object.$object, get-key($name, $key)...);
+    }
+  }
+  @return map.has-key(object.$object, get-key($key: $key)...);
+}

object/_object.keys.function.scss

@@ -1,18 +1,16 @@
 // Sass.
-@use 'sass:list';
 @use 'sass:map';
 
 // Object.
 @use 'object.var' as object;
 
 // Functions.
 @use 'object.get.function' as *;
-@use 'object.last-name.function' as *;
 
 // Status: DONE
-// The `object.keys()` function.
-// @param `$key`
-// @returns
+// The `object.keys()` function gets the keys of object, optionally from value retrieved from `$key`.
+// @param `$key` An optional key of object, or object with key.
+// @returns The returned value is list of keys.
 @function keys($key: null) {
   @return map.keys(get($key));
 }

object/_object.last-id.function.scss

@@ -6,8 +6,8 @@
 @use 'object.var' as object;
 
 // Status: DONE
-// The `object.last-id()` returns last object id.
-// @returns The returned value is  of last added object.
+// The `object.last-id()` returns last created object number.
+// @returns The returned value is number of last created object.
 @function last-id() {
   @return list.length(map.keys(object.$object));
 }