ENH: modernize the src/utils.jl file

Author: sglyon

src/Plotly.jl

@@ -63,8 +63,8 @@ Post a local Plotly plot to the Plotly cloud.
 
 Must be signed in first.
 """
-function post(p::Plot; fileopt=:overwrite, filename=nothing, kwargs...)
-    fileopt = filename == nothing ? :create : Symbol(fileopt)
+function post(p::Plot; fileopt=get_config().fileopt, filename=nothing, kwargs...)
+    fileopt = Symbol(fileopt)
     grid_fn = string(filename, "_", "Grid")
     clean_p = srcify(p; fileopt=fileopt, grid_fn=grid_fn, kwargs...)
     if fileopt == :overwrite
@@ -76,7 +76,7 @@ function post(p::Plot; fileopt=:overwrite, filename=nothing, kwargs...)
             return RemotePlot(res["web_url"])
         end
     end
-    if fileopt == :create
+    if fileopt == :create || fileopt == :new
         if filename == nothing
             res = plot_create(clean_p; kwargs...)
         else
@@ -195,7 +195,7 @@ end
 extract_grid_data(p::Plot) = extract_grid_data!(deepcopy(p))
 
 """
-    srcify!(p::Plot; fileopt::Symbol=:overwrite, grid_fn=nothing, kwargs...)
+    srcify!(p::Plot; fileopt::Symbol=get_config().fileopt, grid_fn=nothing, kwargs...)
 
 This function does three things:
 
@@ -209,7 +209,7 @@ then the changes described above will happen in-place on the grid.
 
 If either of those conditions are not met, then a new grid will be created.
 """
-function srcify!(p::Plot; fileopt::Symbol=:overwrite, grid_fn=nothing, kwargs...)
+function srcify!(p::Plot; fileopt::Symbol=get_config().fileopt, grid_fn=nothing, kwargs...)
     data_for_grid = extract_grid_data!(p)
     temp_map = Dict()
     for (k, v) in data_for_grid
@@ -227,7 +227,7 @@ function srcify!(p::Plot; fileopt::Symbol=:overwrite, grid_fn=nothing, kwargs...
         end
     end
 
-    if fileopt == :create
+    if fileopt == :create || fileopt == :new
         # add order to each grid
         for (i, (k, v)) in enumerate(data_for_grid)
             v["order"] = i-1

src/utils.jl

@@ -1,26 +1,56 @@
 using JSON
 
-const default_endpoints = Dict(
-  "base" => "https://plot.ly",
-  "api" => "https://api.plot.ly/v2"
-)
-
-type PlotlyCredentials
+struct PlotlyCredentials
     username::String
     api_key::String
 end
 
-type PlotlyConfig
+mutable struct PlotlyConfig
     plotly_domain::String
     plotly_api_domain::String
+    plotly_streaming_domain::String
+    plotly_proxy_authorization::Bool
+    plotly_ssl_verification::Bool
+    sharing::String
+    world_readable::Bool
+    auto_open::Bool
+    fileopt::Symbol
+end
+
+const DEFAULT_CONFIG = PlotlyConfig(
+    "https://plot.ly",
+    "https://api.plot.ly/v2",
+    "stream.plot.ly",
+    false,
+    true,
+    "public",
+    true,
+    true,
+    :create
+)
+
+function Base.merge(config::PlotlyConfig, other::Associative)
+    PlotlyConfig(
+        [get(other, string(name), getfield(config, name)) for name in fieldnames(config)]...
+    )
 end
 
-function signin(username::String, api_key::String, endpoints=nothing)
-# Define session credentials/endpoint configuration, where endpoint is a Dict
+Base.show(io::IO, config::PlotlyConfig) = dump(IOContext(io, limit=true), config)
+
+function Base.Dict(config::PlotlyConfig)
+    Dict(k => getfield(config, k) for k in fieldnames(config))
+end
 
+"""
+    signin(username::String, api_key::String, endpoints=nothing)
+
+Define session credentials/endpoint configuration, where endpoint is a Dict
+"""
+function signin(username::String, api_key::String, endpoints::Union{Void,Associative}=nothing)
     global plotlycredentials = PlotlyCredentials(username, api_key)
 
-    # if endpoints are specified both the base and api domains must be specified
+    # if endpoints are specified both the base and api domains must be
+    # specified
     if endpoints != nothing
         try
             base_domain = endpoints["plotly_domain"]
@@ -32,9 +62,12 @@ function signin(username::String, api_key::String, endpoints=nothing)
     end
 end
 
-function get_credentials()
-# Return the session credentials if defined --> otherwise use .credentials specs
+"""
+    get_credentials()
 
+Return the session credentials if defined --> otherwise use .credentials specs
+"""
+function get_credentials()
     if !isdefined(Plotly, :plotlycredentials)
 
         creds = get_credentials_file()
@@ -55,134 +88,89 @@ function get_credentials()
     return plotlycredentials
 end
 
-function get_config()
-# Return the session configuration if defined --> otherwise use .config specs
-
-    if !isdefined(Plotly,:plotlyconfig)
+"""
+    get_config()
 
+Return the session configuration if defined --> otherwise use .config specs
+"""
+function get_config()
+    if !isdefined(Plotly, :plotlyconfig)
         config = get_config_file()
-
-        if isempty(config)
-            base_domain = default_endpoints["base"]
-            api_domain = default_endpoints["api"]
-        else
-            base_domain = get(config, "plotly_domain", default_endpoints["base"])
-            api_domain = get(config, "plotly_api_domain", default_endpoints["api"])
-        end
-
-        global plotlyconfig = PlotlyConfig(base_domain, api_domain)
-
+        global plotlyconfig = merge(DEFAULT_CONFIG, config)
     end
 
     # will persist for the remainder of the session
     return plotlyconfig
 end
 
-function set_credentials_file(input_creds::Dict)
-# Save Plotly endpoint configuration as JSON key-value pairs in
-# userhome/.plotly/.credentials. This includes username and api_key.
+"""
+    set_credentials_file(input_creds::Associative)
 
-    # plotly credentials file
-    userhome = homedir()
-    plotly_credentials_folder = joinpath(userhome, ".plotly")
-    plotly_credentials_file = joinpath(plotly_credentials_folder, ".credentials")
+Save Plotly endpoint configuration as JSON key-value pairs in
+userhome/.plotly/.credentials. This includes username and api_key.
+"""
+function set_credentials_file(input_creds::Associative)
+    credentials_folder = joinpath(homedir(), ".plotly")
+    credentials_file = joinpath(credentials_folder, ".credentials")
 
-    #check to see if dir/file exists --> if not, create it
-    try
-        mkdir(plotly_credentials_folder)
-    catch err
-        isa(err, SystemError) || rethrow(err)
-    end
+    # check to see if dir/file exists --> if not, create it
+    !isdir(credentials_folder) && mkdir(credentials_folder)
 
     prev_creds = get_credentials_file()
+    creds = merge(prev_creds, input_creds)
 
-    #merge input creds with prev creds
-    if !isempty(prev_creds)
-        creds = merge(prev_creds, input_creds)
-    else
-        creds = input_creds
+    # write the json strings to the cred file
+    open(credentials_file, "w") do creds_file
+        write(creds_file, JSON.json(creds))
     end
-
-    #write the json strings to the cred file
-    creds_file = open(plotly_credentials_file, "w")
-    write(creds_file, JSON.json(creds))
-    close(creds_file)
 end
 
-function set_config_file(input_config::Dict)
-# Save Plotly endpoint configuration as JSON key-value pairs in
-# userhome/.plotly/.config. This includes the plotly_domain, and plotly_api_domain.
+"""
+    set_config_file(input_config::Associative)
 
-    # plotly configuration file
-    userhome = homedir()
-    plotly_config_folder = joinpath(userhome, ".plotly")
-    plotly_config_file = joinpath(plotly_config_folder, ".config")
+Save Plotly endpoint configuration as JSON key-value pairs in
+userhome/.plotly/.config. This includes the plotly_domain, and
+plotly_api_domain.
+"""
+function set_config_file(input_config::Associative)
+    config_folder = joinpath(homedir(), ".plotly")
+    config_file = joinpath(config_folder, ".config")
 
-    #check to see if dir/file exists --> if not create it
-    try
-        mkdir(plotly_config_folder)
-    catch err
-        isa(err, SystemError) || rethrow(err)
-    end
+    # check to see if dir/file exists --> if not create it
+    !isdir(config_folder) && mkdir(config_folder)
 
     prev_config = get_config_file()
+    config = merge(prev_config, input_config)
 
-    #merge input config with prev config
-    if !isempty(prev_config)
-        config = merge(prev_config, input_config)
-    else
-        config = input_config
+    # write the json strings to the config file
+    open(config_file, "w") do config_file
+        write(config_file, JSON.json(config))
     end
-
-    #write the json strings to the config file
-    config_file = open(plotly_config_file, "w")
-    write(config_file, JSON.json(config))
-    close(config_file)
 end
 
-function get_credentials_file()
-# Load user credentials as a Dict
-
-    # plotly credentials file
-    userhome = homedir()
-    plotly_credentials_folder = joinpath(userhome, ".plotly")
-    plotly_credentials_file = joinpath(plotly_credentials_folder, ".credentials")
+"""
+    set_config_file(config::PlotlyConfig)
 
-    if !isfile(plotly_credentials_file)
-        creds = Dict()
-    else
-        creds_file = open(plotly_credentials_file)
-        creds = JSON.parse(creds_file)
-
-        if creds == nothing
-            creds = Dict()
-        end
-
-    end
+Set the values in the configuration file to match the values in config
+"""
+set_config_file(config::PlotlyConfig) = set_config_file(Dict(config))
 
-    return creds
+"""
+    get_credentials_file()
 
+Load user credentials informaiton as a dict
+"""
+function get_credentials_file()
+    cred_file = joinpath(homedir(), ".plotly", ".credentials")
+    isfile(cred_file) ? JSON.parsefile(cred_file) : Dict()
 end
 
-function get_config_file()
-# Load endpoint configuration as a Dict
-
-    # plotly configuration file
-    userhome = homedir()
-    plotly_config_folder = joinpath(userhome, ".plotly")
-    plotly_config_file = joinpath(plotly_config_folder, ".config")
+"""
+    get_config_file()
 
-    if !isfile(plotly_config_file)
-        config = Dict()
-    else
-        config_file = open(plotly_config_file)
-        config = JSON.parse(config_file)
-
-        if config == nothing
-            config = Dict()
-        end
-
-    end
-
-    return config
+Load endpoint configuration as a Dict
+"""
+function get_config_file()
+    config_file = joinpath(homedir(), ".plotly", ".config")
+    isfile(config_file) ? JSON.parsefile(config_file) : Dict()
 end

src/v2.jl

@@ -349,26 +349,6 @@ end
 
 try_lookup(path; kwargs...) = try_me(file_lookup, path; kwargs...)
 
-
-"""
-    grid_overwrite(cols::Associative; fid::String="", path::String="")
-
-Replace the data in the grid assocaited with fid `fid` or at the path `path`
-with data in `cols`. `cols` should be an associative mapping from column names
-to column data. The output of this function is an associative mapping from
-column names to column uids in the updated grid.
-
-There are three possible scenarios for the data:
-
-1. The column appears both in the grid and in `cols`. In this case the data in
-   that column of the grid will be updated to match the data in `cols`
-2. The column appears only in `cols`. In this case a new column will be created
-   in the grid
-3. The column appears only in the grid. Nothing happens...
-
-NOTE: only one of `fid` and `path` can be passed
-
-"""
 function grid_overwrite!(cols::Associative; fid::String="", path::String="")
     !isempty(fid) && !isempty(path) && error("Can't pass both fid and path")
     if !isempty(fid)
@@ -380,7 +360,10 @@ function grid_overwrite!(cols::Associative; fid::String="", path::String="")
     end
 
     grid_info == nothing && error("can't overwrite a grid that doesn't exit")
+    grid_overwrite!(grid_info, cols)
+end
 
+function grid_overwrite!(grid_info::Associative, cols::Associative)
     col_name_uid = Dict()
     for col in grid_info["cols"]
         col_name_uid[col["name"]] = col["uid"]
@@ -418,3 +401,25 @@ function grid_overwrite!(cols::Associative; fid::String="", path::String="")
 
     out
 end
+
+
+"""
+    grid_overwrite(cols::Associative; fid::String="", path::String="")
+
+Replace the data in the grid assocaited with fid `fid` or at the path `path`
+with data in `cols`. `cols` should be an associative mapping from column names
+to column data. The output of this function is an associative mapping from
+column names to column uids in the updated grid.
+
+There are three possible scenarios for the data:
+
+1. The column appears both in the grid and in `cols`. In this case the data in
+   that column of the grid will be updated to match the data in `cols`
+2. The column appears only in `cols`. In this case a new column will be created
+   in the grid
+3. The column appears only in the grid. Nothing happens...
+
+NOTE: only one of `fid` and `path` can be passed
+
+"""
+grid_overwrite!