Code Monkey home page Code Monkey logo

ruby-tuples's Introduction

Tuples

Codeship Status for KamilLelonek/ruby-tuples

Ruby implementation for tuples known from functional programming.

Tuple combines a fixed number of items together so that they can be passed around as a whole. Unlike an array or list, a tuple can hold objects with different types but they are also immutable.

Installation

Add this line to your application's Gemfile:

gem 'tuples'

And then execute:

$ bundle

Or install it yourself as:

$ gem install tuples

Usage

You are provided with two classes:

  • Tuple in general
  • Pair in particular

The main difference between two of them are that Pair always consists of 2 elements - when initialized with less - the missing ones are filled with nil, when initialized with more - an ArgumentError is raised.

You can initialize them in different ways:

Tuple.new(1, 2)
Tuple.new([1, 2])
Tuple(1, 2)
Tuple([1, 2])
Tuple[1, 2]

depending on which syntax you feel more convenient with.

Both of the classes have some auxiliary methods:

  • length / arity - which returns number of values inside tuple
  • first / last / second (only pair) - which returns a corresponding elements
  • [] that gives you an access to a particular elements

Tuples are also comparable which means you can compare them, match them in case statement or even sort and find them in an array.

Development

After checking out the repo, run bin/setup to install dependencies. Then, 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 to create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Tests

To run all tests from spec directory execute:

bundle exec rspec

Contributing

  1. Fork it ( https://github.com/[my-github-username]/tuples/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

ruby-tuples's People

Contributors

kamillelonek avatar rlgreen91 avatar

Stargazers

Gideon Fernandes avatar Gerald Bauer avatar Azeem Sajid avatar Yiwei Gao avatar 张硕 avatar Ahmad Hamdi avatar Mateus Medeiros avatar Morton Fox avatar Beomseok Seo avatar Chris Olstrom avatar Alexander Pánek avatar Allen Lee avatar

Watchers

James Cloos avatar  avatar  avatar Ahmad Hamdi avatar

Forkers

rlgreen91

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.