Skip to content

Commit

Permalink
CRAN v1.0.0 (#17)
Browse files Browse the repository at this point in the history
* add license checker and create LICENSE.note

* bump version and ignore things

* init cran comments

* add rhub script

* update yarn lock file

* bump shiny version

* add code marks

* remove shiny version and the shiny functions used are CRAN ready

* prevent devel from saying warnings are errors when making >1mb folder

* fix broken path in package.json

* fix reactlog example in readme (#23)

* Fix vertical sizing issue in firefox esr (#22)

* use utf declaration in html5

* fix height issue for content not shrinking on ESR

* darken legend border

* remove comments

* remove unnecessary flex css tags

* Ubuntu compile (#25)

* add js polyfill

* autoprefix the css

* fix edge legend flexbox issue

* Shiny Reactlog Vignette (#19)

* init vignette helpers

* fix a css issue in the legend. reorder legend

* update readme with example images and link to live demo

* first pass at Shiny Reactlog vignette

* if a search regex starts with r\d, then allow for searching to happen

* fix pkg name issue

* Major additions and edits to vignette

* update images to use invalidating/invalidated colors

* move carson to front and move barret to back of author list

* minor tweaks

* more small fixes

* build pkgdown

* clean up docs with latest images and examples

* remove covr badge and add htmltools as a suggested dep

* use shiny 1.2 functions for now until shiny 1.3 is released

* rhub rc-v1.0.0 execution (#28)

* spelling

* use old fn link for shiny for now

* fix paren

* update cran comments

* Travi-ci deploy pkgdown to gh-pages (#29)

* update travis to deploy to docs folder and copy over latest js for live demo

* remove docs folder to avoid large files being tracked

* ignore docs output as pkgdown is deployed in master branch on travis to gh-pages

* update travis to not deploy from devel. do cleanup.

* deploy on all branches

* fix all_branches location

* move script to before_deploy and not after_success. before_deploy can stop a deployment

* skip cleanup when deploying

* add rc-v1.0.0 branch to deployment branches

* bold reactlog and give contributing.md a title

* fix vig example

* Enable tap for mobile (#31)

* add tap method for cytoscape to allow for mobile finger taps

* working tweaks

* Minor bugs for the status bar (#30)

* do not show two idle steps in a row

* fix in between steps number logic to display the correct number

* display better unknown values

* ignore sequential idle states and async start/stop/idle states at beginning of log.

* clearer var names and remove redundant logic

* Add badges to readme (#33)

* travis tweaks

* spelling

* wording updates

* fix cranwhale link

* add all the badges!

* add pkgdown site in URL

* community support update with Curtis

* link to all reactlog tags in community

* use gifs in readme and remove unused images. adjust title for image

* rerun checks for release

* move js badges to development area. add space above first image

* ignore cran release file

* ignore the folder name to remove the empty folder as well

* put webpack in production mode

* delete reactlog file to use git lfs instead

* track compiled js files with git lfs

* add compiled js files

* merge deploy into release stage

* move readme images to be hosted by github pages

* use only pre-commit package, not husky to allow for git lfs

* remove map file before deleting

* R build ignore the vignettes folder and ignore js map files

* fix travis condition

* deploy from separate stage

* make sure deploy can only happen on push and only for rstudio/reactlog

* track the js map file for better errors using git lfs

* remove js map file again

* remove unnecessary files for vig

* make date static for vignette

* consistent readme image widths

* do not try to add the js map file

* update the gif to show the init step

* Update LICENSE.note

* Update cran-comments.md

* spelling

* please omit the stock LICENSE file.

"The LICENSE file is only needed if you have additional restrictions to
the GPL-3 which you have not? In that please case omit the file."

Martina Schmirl

* single quote package names

"Please always write package names, software names and API names in
single quotes (e.g. 'Shiny') in the Title and the Description field."

Martina Schmirl

* added cran comments

* move images down to let pkgdown steal all images for badges and keep community badges at the top

* Make first word capitalized. Add doi to DESCRIPTION's description

Fixed comments from Uwe

* remove license file
  • Loading branch information
schloerke authored Mar 29, 2019
1 parent 9190586 commit b32a73a
Show file tree
Hide file tree
Showing 83 changed files with 1,418 additions and 79,858 deletions.
23 changes: 16 additions & 7 deletions .Rbuildignore
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
^CRAN-RELEASE$
^Meta$
^doc$
^cran-comments\.md$
^docs$
^_pkgdown\.yml$
^appveyor\.yml$
^.*\.Rproj$
^\.Rproj\.user$
^LICENSE\.md$
^srcjs/
^src_old/
^srcjs
^src_old
^\.babelrc$
^\.eslintrc\.js$
^\.flowconfig$
Expand All @@ -15,12 +19,17 @@
^prettier\.config\.js$
^yarn
^CODE_OF_CONDUCT\.md$
^node_modules/
^inst/log-files/
^bin/
^node_modules
^bin
^inst/reactlogAsset/report.html$
^flow-typed/
^flow-typed
^_ignore
^\.github/
^\.github
^index\.html$
^\.lintr$
^scripts
.*\.js\.map$
^inst/log-files
^readme-images
^inst/gantt
^License.md
2 changes: 1 addition & 1 deletion .babelrc
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"compact": false,
"presets": [
"@babel/preset-flow",
["@babel/preset-env", {"modules": "umd"}]
["@babel/preset-env", {"modules": "umd", "useBuiltIns": "entry"}]
],
"plugins": [
"@babel/plugin-proposal-class-properties"
Expand Down
1 change: 1 addition & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
inst/reactlog/reactlogAsset/*.js filter=lfs diff=lfs merge=lfs -text
2 changes: 2 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Contributing

We welcome contributions to the **reactlog** package!

To submit a contribution:
Expand Down
26 changes: 24 additions & 2 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,15 @@ Delete these instructions once you have read them.

---

Brief description of the problem
## Recording issue

Brief description of the problem. This should show how shiny is not recording something properly.

```r
library(shiny)
library(reactlog)

options("shiny.reactlog" = TRUE)
options(shiny.reactlog = TRUE)

ui <- # FILL IN UI
server <- function(input, output, session) {
Expand All @@ -23,3 +25,23 @@ server <- function(input, output, session) {

shiny::shinyApp(ui = ui, server = server)
```

#### Interactive steps to produce bad reactlog recording

* Select A
* Click plot
* Show reactlog
* ...


-----------------

## Playback issue

Brief description of the problem. Given that Shiny recorded it correctly, the reactlog provided by `shiny::reactlog()` is not being displaying properly.

Please attach a screenshot if appropriate.

```r
jsonlite::toJSON(shiny::reactlog(), pretty = TRUE, auto_unbox = TRUE)
```
24 changes: 11 additions & 13 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,27 +27,25 @@ While you may not be able to submit true `reprex::reprex({#code})` due to the in

Delete these instructions once you have read them.

---
---------------------------------------------

Brief description of the problem

```r
library(shiny)
library(reactlog)
## Playback issue fixed

options("shiny.reactlog" = TRUE)
Brief description of the problem. Given that Shiny recorded it correctly, the reactlog provided by `shiny::reactlog()` is not being displaying properly.

ui <- # FILL IN UI
server <- function(input, output, session) {
# FILL IN SERVER
}
Please attach a screenshot of before and after if appropriate.

shiny::shinyApp(ui = ui, server = server)
```r
jsonlite::toJSON(shiny::reactlog(), pretty = TRUE, auto_unbox = TRUE)
```


PR task list:
---------------------------------------------

## PR task list:

- [ ] Passes `devtools::check()`
- [ ] Add NEWS entry explaining change (reference PR#)
- [ ] Add NEWS entry explaining change (reference username and PR#)
- [ ] Add tests (if appropriate)
- [ ] Update documentation with `devtools::document()`
21 changes: 18 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,37 +1,52 @@
Meta
doc
inst/doc

# History files
.Rhistory
.Rapp.history

# pkgdown output. Covered by travis deploy on master branch
docs/

# Session Data files
.RData

# Example code in package build process
*-Ex.R

# Output files from R CMD build
/*.tar.gz

# Output files from R CMD check
/*.Rcheck/

# RStudio files
.Rproj.user/

# produced vignettes
vignettes/*.html
vignettes/*.pdf

# OAuth2 token, see https://github.com/hadley/httr/releases/tag/v0.3
.httr-oauth

# knitr and R markdown default cache directories
/*_cache/
/cache/

# Temporary files created by R markdown
*.utf8.md
*.knit.md

# Shiny token, see https://shiny.rstudio.com/articles/shinyapps.html
rsconnect/
.Rproj.user

inst/reactlogAsset/report.html
.Rproj.user
inst/reactlog/reactlogAsset/report.html
node_modules
flow-typed
yarn-error.log
src_old

_ignore
*.rej
45 changes: 41 additions & 4 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -1,12 +1,49 @@
language: r
r:
- oldrel
- release
- devel
sudo: false
cache: packages

notifications:
email:
on_success: change
on_failure: change

jobs:
include:
- stage: "R CMD check"
name: "Old Release"
r: oldrel


- name: "Release"
r: release


- name: "Devel"
r: devel


- stage: "Deploy"
name: "pkgdown"
r: release
if: |
branch IN (master, travis, rc-v1.0.0) AND \
type = push AND \
repo = rstudio/reactlog
before_deploy: # build site and copy over files
- Rscript -e 'if(!require("pkgdown")) install.packages("pkgdown")'
- Rscript -e 'pkgdown::build_site()'
# copy reandme images to be hosted by github
- Rscript -e 'stopifnot(file.copy("readme-images/", "docs/", recursive = TRUE))'
# copy inst/reactlog/ to docs/demo/ to maintain live demo on github
- Rscript -e 'stopifnot(file.copy("inst/reactlog/", "docs/", recursive = TRUE)); stopifnot(file.rename("docs/reactlog/", "docs/demo/"))'
deploy:
provider: pages # github pages
local-dir: docs # deploy from docs folder
skip-cleanup: true # keep pkgdown output
keep-history: false # overwrite all git history
on:
# deploy on any branch as condition is done above
all_branches: true
github-token:
secure:
"fH2wg82kkxo6hWJIejIuihnwjysnxMkE6IgmSe6v5Jhg4jNhTZOAZXt0c6nk+nOZfgRKk5xiXbF1WlQWr0lrJakJZ8uKPVJCyZNQMu0A2KykxFoQDK/nZoTzgHTfsTHNpPvE3aaWCPS/VDo1mYFV1vv2MvxpPgcYKFClGeh74oJX30yVE868/HUYVeGnOjRghG7ZMQo7W02dm9W8KSBR1sTAoU0r84ehWCWG0xQCUOAQfoKv5anzx437FFLAxG2ACaBRM9k9I+FFZu6yIlNGC0Qbnsb68uWqtHleofh1FKqGG8CwSgEMQfGrVfqYK0pYVkHueICpIlN0OwFIj+PuL2TTKDPI3XMCkV9m0wp/a3Snd+YjlntlkQ2tdL2l8OhMw9ZE0Q0QXzAWKix+dJ8+GZmtlVhBKG+grZlxiVoTmxTPl13NoQMGIUKkAKuim1nAMJ1CnwXrjb9uk7IUE7ua2E0dDuUJmjtONUwrGAjnq7uSvMn2QbCEml06NuoI+L0NBlaXCgd0MDJoROsqSFlptYPsarkcQWrXZx488OjStmgIWZUmgZqqeWseo+/b9t6MWQk8FTEEvWvrzchaUf3FJbtQZStA64OTMtDJFrivY/mMRLIVKbfVViDJ3SgHA8b1ppZG+CGp7+DLeXlkShtVdjGwnMwYlwivubdCz1nTG7A="
23 changes: 16 additions & 7 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Package: reactlog
Title: Shiny Reactivity Visualizer
Version: 0.0.0.9003
Title: Reactivity Visualizer for 'shiny'
Version: 1.0.0
Authors@R: c(
person(
"Barret", "Schloerke", email = "[email protected]", role = c("aut", "cre"),
Expand All @@ -9,18 +9,27 @@ Authors@R: c(
person("Joe", "Cheng", email = "[email protected]", role = c("ctb")),
person("RStudio", role = c("cph", "fnd"))
)
Description: Display all shiny reactions in a graphical display.
Description: Building interactive web applications with R is incredibly easy
with 'shiny'. Behind the scenes, 'shiny' builds a reactive graph that can
quickly become intertwined and difficult to debug. 'reactlog'
(Schloerke 2019) <doi:10.5281/zenodo.2591517> provides a visual insight into
that black box of 'shiny' reactivity by constructing a directed dependency
graph of the application's reactive state at any time point in a reactive
recording.
Depends:
R (>= 3.0.2)
Imports:
jsonlite (>= 0.9.16)
Suggests:
shiny (>= 1.2.0.9001)
shiny,
knitr,
rmarkdown,
htmltools
License: GPL-3
Encoding: UTF-8
LazyData: true
RoxygenNote: 6.1.1
Remotes:
rstudio/shiny
URL: https://github.com/rstudio/reactlog
URL: https://rstudio.github.io/reactlog/, https://github.com/rstudio/reactlog, https://community.rstudio.com/tags/reactlog
BugReports: https://github.com/rstudio/reactlog/issues
VignetteBuilder: knitr
Language: en-US
5 changes: 1 addition & 4 deletions Gruntfile.js
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ module.exports = function(grunt) {

webpack: {
options: {
mode: "development", // do not take time to shrink files;
mode: "production", // do not take time to shrink files;
devtool: "source-map", // produce a sibling source map file
stats: {
colors: true,
Expand All @@ -24,9 +24,6 @@ module.exports = function(grunt) {
},
progress: true,
failOnError: true,
// optimization: {
// minimize: false // uglify the code
// },
},
reactlog: {
entry: jsSrcdir + "index.js",
Expand Down
Loading

0 comments on commit b32a73a

Please sign in to comment.