Wik feature progressmeter

.github/workflows/format_check.yml

@@ -0,0 +1,40 @@
+name: format-check
+
+on:
+  push:
+    branches:
+      - 'master'
+    tags: '*'
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        julia-version: [1.5.0]
+        julia-arch: [x86]
+        os: [ubuntu-latest]
+    steps:
+      - uses: julia-actions/setup-julia@latest
+        with:
+          version: ${{ matrix.julia-version }}
+
+      - uses: actions/checkout@master
+      - name: Install JuliaFormatter and format
+        run: |
+          julia  -e 'using Pkg; Pkg.add("JuliaFormatter")'
+          julia  -e 'using JuliaFormatter; format(".", annotate_untyped_fields_with_any=false, always_for_in=true, whitespace_in_kwargs=true, whitespace_ops_in_indices=true)'
+      - name: Format check
+        run: |
+          julia -e '
+          out = Cmd(`git diff --name-only`) |> read |> String
+          if out == ""
+              exit(0)
+          else
+              @error "Some files have not been formatted !!!"
+              write(stdout, out)
+              exit(1)
+          end'
+
+

CHANGELOG.md

@@ -1,5 +1,12 @@
 # Javis.jl - Changelog
 
+## Unreleased v0.2
+- Show progress of rendering using [ProgressMeter.jl](https://github.com/timholy/ProgressMeter.jl)
+
+## Unreleased
+- Ability to scale an object with `Scaling`. Works similar to `Translation` and `Rotation` 
+- Added JuliaFormatter GitHub Action
+
 ## 0.1.2 (24th of August 2020)
 - Added capabilities for generating `.mp4` files
 - Updated testing scheme for `Javis.jl`

Project.toml

@@ -8,11 +8,13 @@ FFMPEG = "c87230d0-a227-11e9-1b43-d7ebe4e7570a"
 LaTeXStrings = "b964fa9f-0449-5b57-a5c2-d3ea65f4040f"
 LightXML = "9c8b4983-aa76-5018-a973-4c85ecc9e179"
 Luxor = "ae8d54c2-7ccd-5906-9d76-62fc9837b5bc"
+ProgressMeter = "92933f4c-e287-5a05-a399-4b506db050ca"
 Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
 
 [compat]
 FFMPEG = "0.3, 0.4"
 LaTeXStrings = "1.1"
 LightXML = "0.9"
 Luxor = "2"
+ProgressMeter = "1"
 julia = "1.4"

TODO.md

@@ -8,8 +8,6 @@ graph TD
     B(#102)
     C(#55)
 
-    B --> A
-    C --> A
 ```
 
 - [ ] 102	OPEN	Ability to see animation live without creating pngs	enhancement	2020-08-18 16:46:49 +0000 UTC
@@ -37,7 +35,7 @@ B-->A
 
 ---
 
-- [ ] 103	OPEN	Transformation: Scale	enhancement	2020-08-18 16:54:28 +0000 UTC
+- [X] 103	OPEN	Transformation: Scale	enhancement	2020-08-18 16:54:28 +0000 UTC
 
 - [ ] 98	OPEN	Hijack Plotting Library for Object Positioning	enhancement, question	2020-08-17 19:32:37 +0000 UTC
 
@@ -76,7 +74,7 @@ graph TD
 
 - [ ] 64	OPEN	Javis Templates	Low Priority, To the Moon!, documentation, …	2020-08-09 18:31:06 +0000 UTC
 
-- [ ] 56	OPEN	ProgressMeter	enhancement	2020-08-09 22:21:42 +0000 UTC
+- [x] 56	OPEN	ProgressMeter	enhancement	2020-08-09 22:21:42 +0000 UTC
 
 - [ ] 42	OPEN	Using Animations.jl	enhancement, question	2020-08-05 13:42:17 +0000 UTC
 

docs/make.jl

@@ -2,30 +2,28 @@ using Javis
 using Documenter
 
 makedocs(;
-    modules=[Javis],
-    authors="Ole Kröger <[email protected]> and contributors",
-    repo="https://github.com/Wikunia/Javis.jl/blob/{commit}{path}#L{line}",
-    sitename="Javis.jl",
-    format=Documenter.HTML(;
-        prettyurls=get(ENV, "CI", "false") == "true",
-        canonical="https://Wikunia.github.io/Javis.jl",
-        assets=String[],
+    modules = [Javis],
+    authors = "Ole Kröger <[email protected]> and contributors",
+    repo = "https://github.com/Wikunia/Javis.jl/blob/{commit}{path}#L{line}",
+    sitename = "Javis.jl",
+    format = Documenter.HTML(;
+        prettyurls = get(ENV, "CI", "false") == "true",
+        canonical = "https://Wikunia.github.io/Javis.jl",
+        assets = String[],
     ),
-    pages=[
+    pages = [
         "Home" => "index.md",
-        "Tutorials" =>  [
-	    "tutorials.md",
+        "Tutorials" => [
+            "tutorials.md",
             "tutorials/tutorial_1.md",
             "tutorials/tutorial_2.md",
             "tutorials/tutorial_3.md",
             "tutorials/tutorial_4.md",
-            ],
+        ],
         "Mission" => "mission.md",
         "References" => "references.md",
         "Contributing" => "contributing.md",
     ],
 )
 
-deploydocs(;
-    repo="github.com/Wikunia/Javis.jl",
-)
+deploydocs(; repo = "github.com/Wikunia/Javis.jl")

docs/src/tutorials/tutorial_4.md

@@ -63,7 +63,7 @@ Although one could use standard an `Action` to achieve the same functionality, `
 
 The `subactions` keyword uses a list of [`SubAction`](@ref) structs which are defined in a similar fashion as `Action` with `frames` and a `function` but are in some sense simpler than the `Action`. 
 
-A function of a `SubAction` is normally either [`appear`](@ref) or [`disappear`](@ref) at the moment or one of two transformations: [`Translation`](@ref) and [`Rotation`](@ref).
+A function of a `SubAction` is normally either [`appear`](@ref) or [`disappear`](@ref) at the moment or one of these transformations: [`Translation`](@ref), [`Rotation`](@ref) and [`Scaling`](@ref).
 
 In theory you can define your own but that is way outside of this tutorial.
 

pull_request_template.md

@@ -6,12 +6,13 @@ If you are contributing to `Javis.jl`, please make sure you are able to check of
 - [ ] Did I update the `TODO.md` (if applicable)?
 - [ ] Did I make sure to only change the part of the file where I introduced a new change/feature?
 - [ ] Did I cover all corner cases to be close to 100% test coverage (if applicable)?
+- [ ] Did I properly add Javis dependencies to the `Project.toml` + set an upper bound of the dependency (if applicable)?
 - [ ] Did I properly add test dependencies to the `test` directory (if applicable)?
 - [ ] Did I check relevant tutorials that may be affected by changes in this PR?
 - [ ] Did I clearly articulate why this PR was made the way it was and how it was made?
 
 **Link to relevant issue(s)**
-
+Closes #
 
 
 **How did you address these issues with this PR? What methods did you use?**