1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2022-11-09 12:17:21 -05:00
The Ruby Programming Language [mirror]
Find a file
adamroyjones c70dc3cafb [ruby/csv] Add handling for ambiguous parsing options (https://github.com/ruby/csv/pull/226)
GitHub: fix GH-225

With Ruby 3.0.2 and csv 3.2.1, the file

```ruby
require "csv"
File.open("example.tsv", "w") { |f| f.puts("foo\t\tbar") }
CSV.read("example.tsv", col_sep: "\t", strip: true)
```

produces the error

```
lib/csv/parser.rb:935:in `parse_quotable_robust': TODO: Meaningful
message in line 1. (CSV::MalformedCSVError)
```

However, the CSV in this example is not malformed; instead, ambiguous
options were provided to the parser. It is not obvious (to me) whether
the string should be parsed as

- `["foo\t\tbar"]`,
- `["foo", "bar"]`,
- `["foo", "", "bar"]`, or
- `["foo", nil, "bar"]`.

This commit adds code that raises an exception when this situation is
encountered. Specifically, it checks if the column separator either ends
with or starts with the characters that would be stripped away.

This commit also adds unit tests and updates the documentation.

https://github.com/ruby/csv/commit/cc317dd42d
2021-12-24 14:35:33 +09:00
.github [DOC] Do not push NEWS update to pull-request 2021-12-23 18:43:59 +09:00
basictest
benchmark Prepare for removing RubyVM::JIT (#5262) 2021-12-13 23:07:46 -08:00
bin
bootstraptest @@cv is not accessible from non-main ractors 2021-12-24 13:52:02 +09:00
ccan
coroutine
coverage
cygwin
defs Remove unversioned phony target for pkgconfig file [Bug #18374] 2021-12-04 16:20:30 +09:00
doc [DOC] Add documentation for hash value omission syntax 2021-12-20 01:09:52 +09:00
enc Update dependencies 2021-11-21 16:21:18 +09:00
ext [ruby/bigdecimal] Remove unused variable 2021-12-24 09:44:23 +09:00
gems Update TypeProf to 0.21.1 2021-12-23 18:25:48 +09:00
include Add fiber scheduler hooks for pread/pwrite, and add support to IO::Buffer. 2021-12-23 12:20:09 +13:00
internal Make RubyVM::AbstractSyntaxTree.of raise for backtrace location in eval 2021-12-19 03:51:37 +09:00
lib [ruby/csv] Add handling for ambiguous parsing options (https://github.com/ruby/csv/pull/226) 2021-12-24 14:35:33 +09:00
libexec [rubygems/rubygems] Print warning when running potentially problematic rubygems + ruby combinations 2021-12-21 06:48:27 +09:00
man
misc YJIT: Bounds check every byte in the assembler 2021-12-03 20:02:25 -05:00
missing
sample
spec Merge RubyGems-3.3.2 and Bundler-2.3.2 2021-12-24 10:35:31 +09:00
template Prepare for removing RubyVM::JIT (#5262) 2021-12-13 23:07:46 -08:00
test [ruby/csv] Add handling for ambiguous parsing options (https://github.com/ruby/csv/pull/226) 2021-12-24 14:35:33 +09:00
tool sync_default_gems.rb: Expand GH-xxxx style GitHub links [ci skip] 2021-12-24 14:34:14 +09:00
win32 Rename --jit to --mjit (#5248) 2021-12-13 16:08:01 -08:00
.appveyor.yml [DOC] Skip tests if only documents change [ci skip] 2021-12-16 17:50:20 +09:00
.cirrus.yml Skip tests if only document files changed on Cirrus-CI [ci skip] 2021-11-25 11:10:34 +09:00
.dir-locals.el
.document
.editorconfig
.gdbinit
.gitattributes
.gitignore Ignore preprocessed C++ files [ci skip] 2021-11-21 16:23:44 +09:00
.rspec_parallel
.travis.yml Ignore hung-ups after success on s390x-linux tentatively [ci skip] 2021-12-21 13:40:28 +09:00
aclocal.m4
addr2line.c
addr2line.h
array.c Adding links to literals and Kernel (#5192) 2021-12-03 07:12:28 -06:00
array.rb
ast.c Make AST.of possible even under eval when keep_script_lines is enabled 2021-12-19 04:00:51 +09:00
ast.rb
autogen.sh autogen.sh: Copy auxiliary files instead of symlinks with -i 2021-12-06 17:53:37 +09:00
bignum.c
BSDL
builtin.c
builtin.h
class.c Add docs for Refinement class 2021-12-24 10:31:04 +09:00
common.mk Add fiber scheduler hooks for pread/pwrite, and add support to IO::Buffer. 2021-12-23 12:20:09 +13:00
compar.c
compile.c Remove NODE_DASGN_CURR [Feature #18406] 2021-12-13 12:53:03 +09:00
complex.c Adding links to literals and Kernel (#5192) 2021-12-03 07:12:28 -06:00
configure.ac Move -ljemalloc to DLDLIBS [Bug #18391] 2021-12-07 15:20:02 +09:00
constant.h
cont.c Tidy up fiber scheduler interface documentation for address_resolve and timeout_after. 2021-12-21 17:22:55 +13:00
CONTRIBUTING.md
COPYING
COPYING.ja
darray.h
debug.c
debug_counter.c
debug_counter.h optimize Struct getter/setter 2021-11-19 08:32:39 +09:00
dir.c Expect bool as sort: option at glob [Feature #18287] 2021-11-18 21:47:18 +09:00
dir.rb
dln.c dln.c: refine preprocessor conditions by USE_DLN_DLOPEN and _WIN32 2021-12-17 00:44:54 +09:00
dln.h
dln_find.c
dmydln.c
dmyenc.c
dmyext.c
encindex.h
encoding.c
enum.c Make Enumerable#each_cons return object if over size 2021-11-16 19:31:35 -08:00
enumerator.c
error.c
eval.c Add docs for Refinement class 2021-12-24 10:31:04 +09:00
eval_error.c
eval_intern.h Lazily create singletons on instance_{exec,eval} (#5146) 2021-12-02 15:53:39 -08:00
eval_jump.c
file.c Improved exception usage/classes. 2021-12-21 12:25:42 +13:00
gc.c finalize_deferred doesn't need VM lock 2021-12-23 16:50:17 +09:00
gc.h
gc.rb [DOC] Make sure new GC methods are documented 2021-12-24 10:36:29 +09:00
gem_prelude.rb
golf_prelude.rb
goruby.c
GPL
hash.c Add missing '%' in format string 2021-12-21 18:21:03 +09:00
hrtime.h
id_table.c
id_table.h
inits.c
insns.def Lazily create singletons on instance_{exec,eval} (#5146) 2021-12-02 15:53:39 -08:00
internal.h
io.c [DOC] Enhanced RDoc for IO (#5324) 2021-12-23 10:27:10 -06:00
io.rb
io_buffer.c Add fiber scheduler hooks for pread/pwrite, and add support to IO::Buffer. 2021-12-23 12:20:09 +13:00
iseq.c rb_iseq_update_references() cares script_lines 2021-12-19 06:15:22 +09:00
iseq.h add rb_iseq_type() to return iseq type in Symbol 2021-12-19 05:16:29 +09:00
kernel.rb Improve performance Kernel#Float with using Primitive.mandatory_only? method [Feature #18344] (#5133) 2021-11-17 20:26:40 -08:00
KNOWNBUGS.rb
LEGAL LEGAL: mention error_highlight 2021-12-13 14:21:29 +09:00
lex.c.blt
load.c Allow Kernel#load to load code into a specified module 2021-11-17 22:43:40 -08:00
loadpath.c
localeinit.c
main.c
marshal.c
marshal.rb
math.c
memory_view.c
method.h mandatory_only_cme should not be in def 2021-12-21 11:03:09 +09:00
mini_builtin.c
miniinit.c
mjit.c
mjit.h
mjit_compile.c
mjit_worker.c Rename --jit to --mjit (#5248) 2021-12-13 16:08:01 -08:00
NEWS.md Update default gems list at b0ad6cb371 [ci skip] 2021-12-24 02:20:07 +00:00
nilclass.rb
node.c Remove NODE_DASGN_CURR [Feature #18406] 2021-12-13 12:53:03 +09:00
node.h Remove NODE_DASGN_CURR [Feature #18406] 2021-12-13 12:53:03 +09:00
numeric.c [DOC] Integer.try_convert [ci skip] 2021-12-08 17:59:16 +09:00
numeric.rb Add examples for Integer.try_convert [ci skip] 2021-12-15 02:12:37 +09:00
object.c Remove Class#descendants 2021-12-20 11:02:15 -08:00
pack.c
pack.rb [DOC] Fix String#unpack and #unpack1 docs (#5331) 2021-12-23 21:58:13 +01:00
parse.y Add rb_parser_set_pos function 2021-12-16 20:03:44 +09:00
prelude.rb
probes.d
probes_helper.h
proc.c Fix typos 2021-12-21 17:40:15 +09:00
process.c [DOC] Fix docs rendering for Process._fork [ci skip] 2021-12-15 07:15:02 +09:00
ractor.c
ractor.rb
ractor_core.h
random.c [DOC] Add documentation for Random.rand and Random.seed 2021-12-20 00:50:46 +09:00
range.c Adding links to literals and Kernel (#5192) 2021-12-03 07:12:28 -06:00
rational.c Adding links to literals and Kernel (#5192) 2021-12-03 07:12:28 -06:00
re.c Adding links to literals and Kernel (#5192) 2021-12-03 07:12:28 -06:00
README.EXT
README.EXT.ja
README.ja.md Update badges from README.md [ci skip] 2021-12-24 09:05:12 +09:00
README.md Remove the macOS badge [ci skip] 2021-12-11 23:05:16 +09:00
regcomp.c
regenc.c
regenc.h
regerror.c
regexec.c
regint.h
regparse.c
regparse.h
regsyntax.c
ruby-runner.c
ruby.c Rename --jit to --mjit (#5248) 2021-12-13 16:08:01 -08:00
ruby_assert.h
ruby_atomic.h
rubystub.c
scheduler.c Add fiber scheduler hooks for pread/pwrite, and add support to IO::Buffer. 2021-12-23 12:20:09 +13:00
signal.c
siphash.c
siphash.h
sparc.c
sprintf.c
st.c
strftime.c
string.c [DOC] How to get the longest last match [Bug #18415] 2021-12-19 20:27:31 +09:00
struct.c Fix StructClass:: class method docs 2021-12-24 10:29:31 +09:00
symbol.c Assign temporary ID to anonymous ID [Bug #18250] 2021-11-23 21:03:19 +09:00
symbol.h
thread.c
thread_pthread.c
thread_pthread.h
thread_sync.c [DOC] Improve Thread::Queue.new docs [ci skip] 2021-12-15 11:25:33 +09:00
thread_win32.c
thread_win32.h
time.c Check month overflow when marshal 2021-12-09 21:51:39 +09:00
timev.h
timev.rb [DOC] Fix Time.new description [ci skip] 2021-12-03 13:17:38 +09:00
trace_point.rb TracePoint.allow_reentry 2021-12-10 00:56:25 +09:00
transcode.c
transcode_data.h
transient_heap.c Allow configuring TRANSIENT_HEAP_TOTAL_SIZE 2021-12-10 17:15:17 +09:00
transient_heap.h
util.c
variable.c prohibit load by autoload on non-main Ractor 2021-12-15 02:33:17 +09:00
variable.h
version.c Rename --jit to --mjit (#5248) 2021-12-13 16:08:01 -08:00
version.h * 2021-12-24 [ci skip] 2021-12-24 00:52:06 +09:00
vm.c Show the target Proc on Ractor::IsolationError 2021-12-22 11:10:20 +09:00
vm_args.c
vm_backtrace.c [DOC] Document Thread::Backtrace.limit 2021-12-20 08:56:03 -08:00
vm_callinfo.h mandatory_only_cme should not be in def 2021-12-21 11:03:09 +09:00
vm_core.h make overloaded_cme_table truly weak key map 2021-12-21 15:21:30 +09:00
vm_debug.h Stop including node.h from vm_debug.h only for NODE 2021-11-21 16:21:18 +09:00
vm_dump.c
vm_eval.c Lazily create singletons on instance_{exec,eval} (#5146) 2021-12-02 15:53:39 -08:00
vm_exec.c
vm_exec.h
vm_insnhelper.c @@cv is not accessible from non-main ractors 2021-12-24 13:52:02 +09:00
vm_insnhelper.h
vm_method.c undef rb_vm_lookup_overloaded_cme() 2021-12-23 16:49:49 +09:00
vm_opts.h
vm_sync.c
vm_sync.h
vm_trace.c fix local TP memory leak 2021-12-15 02:31:58 +09:00
vsnprintf.c
warning.rb
yjit.c Rename --jit to --mjit (#5248) 2021-12-13 16:08:01 -08:00
yjit.h Rename --jit to --mjit (#5248) 2021-12-13 16:08:01 -08:00
yjit.rb YJIT: Edit module documentation for clarity 2021-12-11 18:45:07 -05:00
yjit_asm.c YJIT: Fix unexpected truncation when outputing VALUE 2021-12-14 19:47:42 -05:00
yjit_asm.h YJIT: Bounds check every byte in the assembler 2021-12-03 20:02:25 -05:00
yjit_codegen.c YJIT: Implement intern 2021-12-18 15:59:30 -05:00
yjit_codegen.h YJIT: Fail gracefully while OOM for new entry points 2021-12-01 12:25:28 -05:00
yjit_core.c YJIT: Remove unused branch_t::src_ctx field 2021-12-15 16:13:23 -05:00
yjit_core.h YJIT: Remove unused branch_t::src_ctx field 2021-12-15 16:13:23 -05:00
yjit_iface.c Rename --jit to --mjit (#5248) 2021-12-13 16:08:01 -08:00
yjit_iface.h
yjit_utils.c YJIT: Add ability to exit to interpreter from stubs 2021-11-26 18:00:42 -05:00

Actions Status: MinGW Actions Status: MJIT Actions Status: Ubuntu Actions Status: Windows AppVeyor status Travis Status Cirrus Status

What's Ruby

Ruby is an interpreted object-oriented programming language often used for web development. It also offers many scripting features to process plain text and serialized files, or manage system tasks. It is simple, straightforward, and extensible.

Features of Ruby

  • Simple Syntax
  • Normal Object-oriented Features (e.g. class, method calls)
  • Advanced Object-oriented Features (e.g. mix-in, singleton-method)
  • Operator Overloading
  • Exception Handling
  • Iterators and Closures
  • Garbage Collection
  • Dynamic Loading of Object Files (on some architectures)
  • Highly Portable (works on many Unix-like/POSIX compatible platforms as well as Windows, macOS, etc.) cf. https://github.com/ruby/ruby/blob/master/doc/maintainers.rdoc#label-Platform+Maintainers

How to get Ruby

For a complete list of ways to install Ruby, including using third-party tools like rvm, see:

https://www.ruby-lang.org/en/downloads/

Git

The mirror of the Ruby source tree can be checked out with the following command:

$ git clone https://github.com/ruby/ruby.git

There are some other branches under development. Try the following command to see the list of branches:

$ git ls-remote https://github.com/ruby/ruby.git

You may also want to use https://git.ruby-lang.org/ruby.git (actual master of Ruby source) if you are a committer.

Subversion

Stable branches for older Ruby versions can be checked out with also the following command:

$ svn co https://svn.ruby-lang.org/repos/ruby/branches/ruby_2_6/ ruby

Try the following command to see the list of branches:

$ svn ls https://svn.ruby-lang.org/repos/ruby/branches/

Ruby home page

https://www.ruby-lang.org/

Mailing list

There is a mailing list to discuss Ruby. To subscribe to this list, please send the following phrase:

subscribe

in the mail body (not subject) to the address ruby-talk-request@ruby-lang.org.

Requirements to build from repository

  1. GNU or BSD make
  2. C99 compiler
  3. autoconf 2.67 or higher
  4. automake 1.15 or higher
  5. bison 2.3 or higher
  6. Ruby 2.2 or higher

When building from a released version, only a C99 compiler and GNU or BSD make is required.

How to compile and install

  1. If you want to use Microsoft Visual C++ to compile Ruby, read win32/README.win32 instead of this document.

  2. Run ./autogen.sh to generate configure, when you build the source checked out from the Git repository.

  3. Run ./configure, which will generate config.h and Makefile.

    Some C compiler flags may be added by default depending on your environment. Specify optflags=.. and warnflags=.. as necessary to override them.

  4. Edit include/ruby/defines.h if you need. Usually this step will not be needed.

  5. Optional: Remove comment mark(#) before the module names from ext/Setup.

    This step is only necessary if you want to link modules statically.

    If you don't want to compile dynamic extensions (probably on architectures which do not allow dynamic loading), remove comment mark from the line "#option nodynamic" in ext/Setup.

    Usually this step will not be needed.

  6. Run make.

    • On Mac, set RUBY_CODESIGN environment variable with a signing identity. It uses the identity to sign ruby binary. See also codesign(1).
  7. Optionally, run 'make check' to check whether the compiled Ruby interpreter works well. If you see the message "check succeeded", your Ruby works as it should (hopefully).

  8. Run 'make install'.

    This command will create the following directories and install files into them.

    • ${DESTDIR}${prefix}/bin
    • ${DESTDIR}${prefix}/include/ruby-${MAJOR}.${MINOR}.${TEENY}
    • ${DESTDIR}${prefix}/include/ruby-${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}
    • ${DESTDIR}${prefix}/lib
    • ${DESTDIR}${prefix}/lib/ruby
    • ${DESTDIR}${prefix}/lib/ruby/${MAJOR}.${MINOR}.${TEENY}
    • ${DESTDIR}${prefix}/lib/ruby/${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}
    • ${DESTDIR}${prefix}/lib/ruby/site_ruby
    • ${DESTDIR}${prefix}/lib/ruby/site_ruby/${MAJOR}.${MINOR}.${TEENY}
    • ${DESTDIR}${prefix}/lib/ruby/site_ruby/${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}
    • ${DESTDIR}${prefix}/lib/ruby/vendor_ruby
    • ${DESTDIR}${prefix}/lib/ruby/vendor_ruby/${MAJOR}.${MINOR}.${TEENY}
    • ${DESTDIR}${prefix}/lib/ruby/vendor_ruby/${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}
    • ${DESTDIR}${prefix}/lib/ruby/gems/${MAJOR}.${MINOR}.${TEENY}
    • ${DESTDIR}${prefix}/share/man/man1
    • ${DESTDIR}${prefix}/share/ri/${MAJOR}.${MINOR}.${TEENY}/system

    If Ruby's API version is 'x.y.z', the ${MAJOR} is 'x', the ${MINOR} is 'y', and the ${TEENY} is 'z'.

    NOTE: teeny of the API version may be different from one of Ruby's program version

    You may have to be a super user to install Ruby.

If you fail to compile Ruby, please send the detailed error report with the error log and machine/OS type, to help others.

Some extension libraries may not get compiled because of lack of necessary external libraries and/or headers, then you will need to run 'make distclean-ext' to remove old configuration after installing them in such case.

Copying

See the file COPYING.

Feedback

Questions about the Ruby language can be asked on the Ruby-Talk mailing list or on websites like https://stackoverflow.com.

Bugs should be reported at https://bugs.ruby-lang.org. Read HowToReport for more information.

Contributing

See the file CONTRIBUTING.md

The Author

Ruby was originally designed and developed by Yukihiro Matsumoto (Matz) in 1995.

matz@ruby-lang.org