Code Monkey home page Code Monkey logo

questiongenerator's Introduction

questiongenerator

A simple question generator, used by Retrospring (formerly justask).

Installation

Add this line to your application's Gemfile:

gem 'questiongenerator'

If you're feeling edgy, you can add this line instead:

gem 'questiongenerator', git: 'https://github.com/nilsding/questiongenerator.git'

Usage

require 'questiongenerator'

# Configure it
QuestionGenerator.question_base_path = '/home/nilsding/questions'
QuestionGenerator.default_locale = :en

# Compile the questions for increased randomness
QuestionGenerator.compile

# Get some questions
puts QuestionGenerator.generate
# => "What is the best thing about the internet?"

# You can also specify the locale, if you want to
puts QuestionGenerator.generate locale: :de
# => "Was war das letzte, das du gegessen hast?"

# You can also specify an own prefix or suffix:
puts QuestionGenerator.generate locale: :fr, prefix: '[FR] ', suffix: ' ?'
# => "[FR] Quelle est la personne la plus célèbre que vous avez rencontrée ?"

How it works

The question generator uses a simple branching structure inside the specified locale to generate questions from it, here is a quick example:

Can:
  you:
    - swim
    - speak:
      - different:
        - languages
    - play:
      - any:
        - sports
      - the:
        - piano
        - guitar
        - trumpet
      - baseball
    - ski
    - cook
    - dance

# The following example outputs:
# Can you swim?
# Can you speak different languages?
# Can you play any sports?
# Can you play the piano?
#               ...guitar?
#               ...trumpet?
# Can you play baseball?
# Can you ski?
# Can you cook?
# Can you dance?

If you can't break sentences in parts in your language, you can also specify the entire question in one line.

- Can you swim

# The following example outputs:
# Can you swim?

Contributing

The files for questions are located in lib/questions/

If you want to add a new language, create a new file and name it with the ISO-639-1 language code of it (just like en.yml)

  1. Fork it ( https://github.com/nilsding/questiongenerator/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

Please don't add harassing, scaring or upsetting content to the questions or content that otherwise violates the Retrospring Terms of Service.

If you add questions in another language to the questiongenerator and purposely add wrong translations, further Pull Requests will be ignored.

questiongenerator's People

Contributors

daebb avatar nilsding avatar pixeldesu avatar quadpiece avatar seatsea avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

Forkers

seatsea danilf daebb

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.