rs-store 3.0.0

Redux Store for Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117

.DEFAULT_GOAL := help

.PHONY: help build clean
help:  ## show this help
	@cat $(MAKEFILE_LIST) | grep -E "^[a-zA-Z0-9_-]+:.*?## .*$$" | \
    awk 'BEGIN {FS = ":.*?# "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'

setup:	## setup
	cargo install cargo-tarpaulin

build:	## build
	RUSTFLAGS="-D warnings" cargo build --lib

build-dev: ## build for development
	RUSTFLAGS="-D warnings" cargo build --lib --profile dev

build-full: ## build for release
	RUSTFLAGS="-D warnings" cargo build --lib --features full


clean:	## clean
	cargo clean

test-all: test test-dev examples example-dropoldest_if ## test all

.PHONY: test
test:	## test
	RUST_TEST_THREADS=1 RUST_LOG=debug cargo test  -- --nocapture

test-test_store_iter_with_different_policies:
	RUST_TEST_THREADS=1 RUST_LOG=debug cargo test --test store_impl::tests::test_store_iter_with_different_policies -- --nocapture

test-test_store_get_state:
	RUST_TEST_THREADS=1 RUST_LOG=debug cargo test --package rs-store --lib store::tests::test_store_get_state --features store-log -- --nocapture

test-store_impl:
	RUST_TEST_THREADS=1 RUST_LOG=debug cargo test --package rs-store --lib store_impl::tests --profile test --features store-log -- --nocapture

.PHONY: test-dev
test-dev:	## test with log
	RUST_TEST_THREADS=1 RUST_LOG=debug cargo test --profile dev  -- --nocapture

.PHONY: test-cov
test-cov:	## Run test coverage using tarpaulin
	cargo tarpaulin --verbose --all-features --workspace --timeout 120 \
		--out Html --output-dir coverage \
		--exclude-files "examples/*"

.PHONY: test-cov-open
test-cov-open: test-cov	## Run test coverage and open the report
	@if [ "$(shell uname)" = "Darwin" ]; then \
		open coverage/tarpaulin-report.html; \
	elif [ "$(shell uname)" = "Linux" ]; then \
		xdg-open coverage/tarpaulin-report.html; \
	fi

.PHONY: lint
lint:	## lint
	cargo clippy

.PHONY: fmt
fmt: ## format
	cargo fmt

.PHONY: doc
doc:	## doc
	cargo doc --lib --no-deps -p rs-store

.PHONY: examples
examples: ## example all
	RUSTFLAGS="-D warnings" cargo run --example simple -- --nocapture
	RUSTFLAGS="-D warnings" cargo run --example store_trait -- --nocapture
	RUSTFLAGS="-D warnings" cargo run --example calc_basic -- --nocapture
	RUSTFLAGS="-D warnings" cargo run --example calc_fn_basic -- --nocapture
	RUSTFLAGS="-D warnings" cargo run --example calc_concurrent -- --nocapture
	RUSTFLAGS="-D warnings" cargo run --example calc_unsubscribe -- --nocapture
	RUSTFLAGS="-D warnings" cargo run --example calc_thunk -- --nocapture
	RUSTFLAGS="-D warnings" cargo run --example calc_basic_builder -- --nocapture
#	RUSTFLAGS="-D warnings" cargo run --example iter_state -- --nocapture
	RUSTFLAGS="-D warnings" cargo run --example dropoldest_if -- --nocapture
	RUSTFLAGS="-D warnings" cargo run --example calc_query_state -- --nocapture
	
example-dropoldest_if:
	RUSTFLAGS="-D warnings" cargo run --features store-log --example dropoldest_if -- --nocapture --features store-log

example-performance_state_size:
	RUST_LOG=debug RUST_TRACEBACK=1 cargo run --example performance_state_size -- --nocapture


VERSION := $(shell cargo pkgid -p "rs-store" | cut -d\# -f2 | cut -d@ -f2)

.PHONY: version
version:
#	cargo metadata --no-deps --format-version=1 | jq -r '.packages[] | select(.name == "rs-store") | .version'
	@echo $(VERSION)

.PHONY: check_version_tag
check_version_tag: TAG_EXISTS := $(shell git tag | grep -q "^v$(VERSION)" && echo "true" || echo "false")
check_version_tag:	## check version tag
	# version tag should not be found
	[ "$(TAG_EXISTS)" = "false" ]

.PHONY: add_tag
add_tag:	## add tag
	git tag -a "v$(VERSION)" -m "v$(VERSION)"

.PHONY: publish
publish: check_version_tag build test-all publish_cargo add_tag	## publish
	@echo "published v$(VERSION)"
	@echo push tag v$(VERSION) to origin
	@git push origin v$(VERSION)
	@git push origin main

.PHONY: publish_cargo
publish_cargo:	## publish to cargo
	cargo login
	cargo publish