Project

tuga

0.0
The project is in a healthy, maintained state
A Portuguese script programming language meant for educational purposes.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 2.0
~> 2.18
~> 0.60
~> 0.14
~> 0.17.1
~> 0.9
~> 0.9
~> 13.0
~> 3.12
~> 1.56.1
~> 0.0.9

Runtime

 Project Readme

Tuga

Gem Version Build Status Maintainability Test Coverage Inline docs

A Portuguese script programming language meant for educational purposes.

Requirements

The gem requires version 3.2 of the Ruby programming language.

Installation

Add this line to your application's Gemfile:

gem 'tuga'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install tuga

Usage

In the command line

Run the tuga command followed by a filename.

tuga soure_code.pt

In an application

Require the Tuga transpiler and give it Tuga source code.

require 'tuga/transpiler'

source_code = <<~BACALHAU
  lista_de_frutas = ['maçã', 'manga', 'goiaba', 'uva']

  por_cada fruta na lista_de_frutas fazer
    escrever fruta.com_letra_maiuscula
  fim
BACALHAU

transpiler = Tuga::Transpiler.new
transpiler.to_ruby(source_code)

Development

After checking out the repo, run bin/setup to install dependencies, configure git hooks and create support files.

You can also run bin/console for an interactive prompt that will allow you to experiment.

The health and maintainability of the codebase is ensured through a set of Rake tasks to test, lint and audit the gem for security vulnerabilities and documentation:

rake build                 # Build tuga-x.x.x.gem into the pkg directory
rake build:checksum        # Generate SHA512 checksum if tuga-0.x.x.gem into the checksums directory
rake bundle:audit:check    # Checks the Gemfile.lock for insecure dependencies
rake bundle:audit:update   # Updates the bundler-audit vulnerability database
rake clean                 # Remove any temporary products
rake clobber               # Remove any generated files
rake coverage              # Run spec with coverage
rake install               # Build and install tuga-x.x.x.gem into system gems
rake install:local         # Build and install tuga-x.x.x.gem into system gems without network access
rake qa                    # Test, lint and perform security and documentation audits
rake release[remote]       # Create tag vx.x.x and build and push tuga-x.x.x.gem to rubygems.org
rake rubocop               # Run RuboCop
rake rubocop:auto_correct  # Auto-correct RuboCop offenses
rake spec                  # Run RSpec code examples
rake verify_measurements   # Verify that yardstick coverage is at least 100%
rake yard                  # Generate YARD Documentation
rake yard:junk             # Check the junk in your YARD Documentation
rake yardstick_measure     # Measure docs in lib/**/*.rb with yardstick

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/wilsonsilva/tuga. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Tuga project's codebases, issue trackers, chat rooms and mailing lists is expected to ollow the code of conduct.