esilkensen / yaml Goto Github PK

View Code? Open in Web Editor NEW

19.0 19.0 5.0 732 KB

A YAML library for Racket.

License: MIT License

Racket 100.00%

yaml's People

Contributors

Stargazers

Watchers

Forkers

adolfopa samth aymanosman eutro

yaml's Issues

Issue #1799: document error in null example

http://planet.racket-lang.org/trac/ticket/1799

Issue #1619: (string->yaml "a:") throws a non-scanner-error

http://planet.racket-lang.org/trac/ticket/1619

Question: Yaml Events or use of `yaml/events`

Quick question.

I'm interested in customizing the data-structures produced by the parser. For example, I want to create an ordered mapping object instead of using #hash() structures or perhaps use immutable hashes.

Would you suggest I use the yaml/events module? If so, I could try that out and maybe document it.

Thanks for your work.

Add representer for Racket byte strings

Issue #1621: cannot hande "..."

http://planet.racket-lang.org/trac/ticket/1621

Rename "test" and "tests" directories

yaml library pukes on []

The following yaml causes an error.

check: []

I get when loading this yaml:

make-constructor: broke its own contract
  promised: (or/c yaml? void?)
  produced: '#hash(("checks" . ()))
  in: the range of
      the range of
      (->*
       ()
       (input-port?)
       (values
        (-> boolean?)
        (-> (or/c yaml? void?))
        (-> (or/c yaml? #f))))
  contract from: 
      <pkgs>/yaml/yaml/constructor.rkt
  blaming: <pkgs>/yaml/yaml/constructor.rkt
   (assuming the contract is correct)
  at: <pkgs>/yaml/yaml/constructor.rkt:21.3

Add file->yaml, file->yaml* functions

Issue #1622: string->yaml: broke its contract

http://planet.racket-lang.org/trac/ticket/1622

Writing a yaml file with unicode characters cannot be read back

Yaml document contains scalars with unicode characters are written using escaped characters. Such files cannot be read back.

Steps to reproduce:
Test file: test.yaml.txt

> (file->yaml "test.yaml")
'#hash(("key" . "Å üñíçòðę vǎlûe"))
> (yaml->string (file->yaml "test.yaml"))
"{key: \"\\xC5 \\xFC\\xF1\\xED\\xE7\\xF2\\xF0\\u119 v\\u1CEl\\xFBe\"}\n"
> (string->yaml (yaml->string (file->yaml "test.yaml")))
; string:0:38: while scanning a double-quoted scalar;
;  expected escape sequence, but found
; [,bt for context]

Problem can be solved with the attached patch:
allow-unicode.patch.txt

> (file->yaml "test.yaml")
'#hash(("key" . "Å üñíçòðę vǎlûe"))
> (yaml->string (file->yaml "test.yaml") #:allow-unicode? #t)
"{key: Å üñíçòðę vǎlûe}\n"
> (string->yaml (yaml->string (file->yaml "test.yaml") #:allow-unicode? #t))
'#hash(("key" . "Å üñíçòðę vǎlûe"))

Expand and enhance test suite

Rename test files from the YAML spec, e.g., "ex2-1" to "spec02-01.yaml".

Expand the test suite to include other examples from the spec and the PyYAML repository: See http://svn.pyyaml.org/pyyaml/trunk/tests/data/ and http://yaml.org/spec/

Test yaml-struct and scoping

What happens when there are multiple yaml-struct definitions with the same name (and what if they are in different scopes, modules, etc.)?

write-yaml breaks make-representer contract on #:style

-> (write-yaml '(1 2 3) #:style 'flow)
; make-representer: contract violation
;   expected: (or/c (quote block) (quote flow) (quote best) #f)
;   given: #t
;   in: the #:style argument of
;       (->*
;        ((-> node? void?))
;        (#:scalar-style
;         (or/c #\" #\' #\| #\> 'plain #f)
;         #:style
;         (or/c 'block 'flow 'best #f))
;        (-> yaml? void?))

Issue #1798: document error in value example

http://planet.racket-lang.org/trac/ticket/1798

Provide API for implementing user-defined tags

Issue #1797: contract violation in merge example

http://planet.racket-lang.org/trac/ticket/1797

Issue #1620: doesn't recognize octal number

http://planet.racket-lang.org/trac/ticket/1620

Incorrect timezone handling in construct-yaml-timestamp

The following YAML input is not constructed correctly:

canonical: 2001-12-15T02:59:43.1Z
iso8601: 2001-12-14t21:59:43.10-05:00
spaced: 2001-12-14 21:59:43.10 -5
date: 2002-12-14

The "iso8601" and "spaced" dates return the wrong hour value.

lose the dependency on coveralls?

I see that yaml requires cover-coveralls, and it looks to me like this is used only in the travis script. This is a bit of a bummer if I want to include yaml in another project... is the coverage testing a significant component of the CI testing?

Hmm... well, I suppose you could argue either way.

Support writing hash tables in an ordered manner (possibly with an optional keyword argument)

I think for an object that has many attributes, the output will be easier for humans to read if the keys are ordered. This may also apply to sets.

Issue #1793: unexpected result when parsing YAML file

http://planet.racket-lang.org/trac/ticket/1793

Make yaml? contract aware of representers

Use GitHub Actions instead of Travis

Consider moving away from Travis and using GitHub Actions instead.

Fix Travis CI and Coveralls configuration

The Travis build runs Coveralls but fails to run the tests and reports only 15% coverage. Probably a yaml/yaml directory issue.

Add rendered Scribble docs as a GitHub page

See https://groups.google.com/d/topic/racket-users/VfNLit_t17M/

Use Racket classes or structs

Refactor scanner.rkt, parser.rkt, etc. to use Racket classes or structs instead of closures / constructors that return values.

Issue #1623: string: contract violation expected: char? given: #<eof>

http://planet.racket-lang.org/trac/ticket/1623

bug in error message

Evaulate this program

#lang racket
(require yaml)
(string->yaml ": {fall: [], winter: [], spring: []}")

see this error:

format: format string requires 0 arguments, given 1; arguments were: "expected , but found" "':'"

It certainly looks like the part of the code that's supposed to signal this error message has a bad format string.

make-serializer broke its own contract

Entering the examples from the documentation breaks the make-serializer contract:

> (write-yaml
     '(#hash(("name" . "Mark McGwire")
             ("hr" . 65)
             ("avg" . 0.278))
       #hash(("name" . "Sammy Sosa")
             ("hr" . 63)
             ("avg" . 0.288))))

; make-serializer: broke its own contract;
;  expected 1 value, returned 3 values
;   in: the range of
;       (->*
;        ()
;        (output-port?
;         #:allow-unicode
;         boolean?
;         #:canonical
;         boolean?
;         #:explicit-end
;         boolean?
;         #:explicit-start
;         boolean?
;         #:indent
;         (or/c exact-positive-integer? #f)
;         #:line-break
;         (or/c "\n" "\r" "\r\n" #f)
;         #:tags
;         (or/c (hash/c string? string?) #f)
;         #:version
;         (or/c
;          (cons/c exact-integer? exact-integer?)
;          #f)
;         #:width
;         (or/c exact-positive-integer? #f))
;        (-> node? void?))
;   contract from:
;       /Users/Erik/Documents/Code/yaml/yaml/serializer.rkt
;   blaming: /Users/Erik/Documents/Code/yaml/yaml/serializer.rkt
;    (assuming the contract is correct)
;   at: /Users/Erik/Documents/Code/yaml/yaml/serializer.rkt:15.3

#lang racket

(require yaml)

(string->yaml "name: Oracle
\tid: oracle
description: Oracle.
" )

This results in the error:

string:1:0: while scanning for the next token;
 found character     that cannot start any token

... which is a bit of a challenge to read.

Issue #1624: could not determine a constructor for the tag tag:yaml.org,2002:merge

http://planet.racket-lang.org/trac/ticket/1624

It would be nice if a license is specified

As it is right now, this library seems to have no license (unless I've missed it). I'm not sure if this is intentional --- if so, I apologize for bothering you.

If not, GitHub's Choose a License site is a pretty good starting point for picking a license.