https://github.com/ruby/cgi
CGI is a large class, providing several categories of methods, many of which are mixed in from other modules.
https://github.com/ruby/cgi
Last synced: about 1 month ago
JSON representation
CGI is a large class, providing several categories of methods, many of which are mixed in from other modules.
- Host: GitHub
- URL: https://github.com/ruby/cgi
- Owner: ruby
- License: other
- Created: 2019-08-06T03:27:20.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2025-05-12T03:36:36.000Z (about 1 month ago)
- Last Synced: 2025-05-12T04:32:40.804Z (about 1 month ago)
- Language: Ruby
- Homepage:
- Size: 784 KB
- Stars: 37
- Watchers: 37
- Forks: 25
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- License: COPYING
Awesome Lists containing this project
README
## Introduction
CGI is a large class, providing several categories of methods, many of which
are mixed in from other modules. Some of the documentation is in this class,
some in the modules CGI::QueryExtension and CGI::HtmlExtension. See
CGI::Cookie for specific information on handling cookies, and cgi/session.rb
(CGI::Session) for information on sessions.
For queries, CGI provides methods to get at environmental variables,
parameters, cookies, and multipart request data. For responses, CGI provides
methods for writing output and generating HTML.
Read on for more details. Examples are provided at the bottom.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'cgi'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install cgi
## Usage
### Get form values
Given a form with the content `field_name=123`:
```ruby
require "cgi"
cgi = CGI.new
value = cgi['field_name'] # => "123"
cgi['flowerpot'] # => ""
fields = cgi.keys # => [ "field_name" ]
cgi.has_key?('field_name') # => true
cgi.include?('field_name') # => true
cgi.include?('flowerpot') # => false
```
### Get form values as hash
```ruby
require "cgi"
cgi = CGI.new
params = cgi.params
```
cgi.params is a hash.
```ruby
cgi.params['new_field_name'] = ["value"] # add new param
cgi.params['field_name'] = ["new_value"] # change value
cgi.params.delete('field_name') # delete param
cgi.params.clear # delete all params
```
### Save form values to file
```ruby
require "pstore"
db = PStore.new("query.db")
db.transaction do
db["params"] = cgi.params
end
```
### Restore form values from file
```ruby
require "pstore"
db = PStore.new("query.db")
db.transaction do
cgi.params = db["params"]
end
```
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/ruby/cgi.