tuples 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7dfcd356f4c8faa253eceffec0148e480fe2653f
+  data.tar.gz: ea9f940b9cd46365f03f5e93ceccf0c1f891b25f
+SHA512:
+  metadata.gz: d69145b46dcfbfce82c5a5f137620cf5fa316cbde1048b70cdcc0927709a06d9a70240fef28277c77efc4b4107996a513f12e5b5ac081251eca7fbfa440bc4bb
+  data.tar.gz: 52403cc9cc718ef69af38dd3e133f0e031b19f487f5695494d46f0456cdc249763e5e8520198dde4ca45be576320f725d311124d48ac335a1e7b8520b8771e11

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.1

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,49 @@
+PATH
+  remote: .
+  specs:
+    tuples (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (4.0.5)
+      columnize (= 0.9.0)
+    coderay (1.1.0)
+    columnize (0.9.0)
+    diff-lcs (1.2.5)
+    method_source (0.8.2)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-byebug (3.1.0)
+      byebug (~> 4.0)
+      pry (~> 0.10)
+    rake (10.4.2)
+    rspec (3.2.0)
+      rspec-core (~> 3.2.0)
+      rspec-expectations (~> 3.2.0)
+      rspec-mocks (~> 3.2.0)
+    rspec-collection_matchers (1.1.2)
+      rspec-expectations (>= 2.99.0.beta1)
+    rspec-core (3.2.3)
+      rspec-support (~> 3.2.0)
+    rspec-expectations (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-mocks (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-support (3.2.2)
+    slop (3.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.9)
+  pry-byebug (~> 3.1.0)
+  rake (~> 10.0)
+  rspec (~> 3.2.0)
+  rspec-collection_matchers (~> 1.1.2)
+  tuples!

data/README.md

@@ -0,0 +1,70 @@
+# Tuples
+
+[ ![Codeship Status for KamilLelonek/ruby-tuples](https://codeship.com/projects/c82b3680-e2e1-0132-cc6e-76e3d81118b5/status?branch=master)](https://codeship.com/projects/81591)
+
+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:
+
+```ruby
+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 `Tuple` always consist 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](https://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

data/Rakefile

@@ -0,0 +1,5 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'tuples'
+
+require 'pry'
+Pry.start

data/bin/setup

@@ -0,0 +1,6 @@
+#!/bin/bash
+
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install

data/lib/tuples.rb

@@ -0,0 +1,8 @@
+require 'pathname'
+
+(require_files = -> (initial_path = __dir__) do
+  Pathname.new(initial_path).each_child do |file|
+    File.directory?(file) and require_files[file] or
+      File.extname(file) == '.rb' and require_relative file.expand_path
+  end
+end).call

data/lib/tuples/pair.rb

@@ -0,0 +1,21 @@
+require_relative 'tuple'
+
+class Pair < Tuple
+  def initialize(*values)
+    values.flatten.tap do |arguments|
+      raise ArgumentError, 'Pair must contain only two elements' if more_than_two_arguments?(arguments)
+      super(arguments[0], arguments[1])
+    end
+  end
+
+  alias_method :second, :last
+
+  private
+  def more_than_two_arguments?(arguments)
+    arguments.length > 2
+  end
+end
+
+def Pair(*values)
+  Pair.new(*values)
+end

data/lib/tuples/tuple.rb

@@ -0,0 +1,36 @@
+class Tuple
+  extend  Forwardable
+  include Comparable
+
+  def initialize(*values)
+    @values = values.flatten.freeze
+  end
+
+  def self.[](*values)
+    new(*values)
+  end
+
+  def <=>(other)
+    return unless other.kind_of? self.class
+    values <=> other.values
+  end
+
+  def invert
+    Tuple(*values.reverse)
+  end
+
+  def_delegators :values,
+                 :length,
+                 :first,
+                 :last,
+                 :[]
+
+  alias_method :arity, :length
+
+  protected
+  attr_reader :values
+end
+
+def Tuple(*values)
+  Tuple.new(*values)
+end

data/lib/tuples/version.rb

@@ -0,0 +1,3 @@
+module Tuples
+  VERSION = '0.1.0'
+end

data/tuples.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'tuples/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'tuples'
+  spec.version       = Tuples::VERSION
+  spec.authors       = ['Kamil Lelonek']
+  spec.email         = ['squixy.sln@gmail.com']
+  spec.summary       = %q{Ruby implementation for tuples known from functional programming}
+  spec.description   = %q{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.}
+  spec.homepage      = 'https://github.com/KamilLelonek/ruby-tuples'
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler',                   '~> 1.9'
+  spec.add_development_dependency 'rake',                      '~> 10.0'
+  spec.add_development_dependency 'pry-byebug',                '~> 3.1.0'
+  spec.add_development_dependency 'rspec',                     '~> 3.2.0'
+  spec.add_development_dependency 'rspec-collection_matchers', '~> 1.1.2'
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: tuples
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kamil Lelonek
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-05-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: rspec-collection_matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+description: 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.
+email:
+- squixy.sln@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/tuples.rb
+- lib/tuples/pair.rb
+- lib/tuples/tuple.rb
+- lib/tuples/version.rb
+- tuples.gemspec
+homepage: https://github.com/KamilLelonek/ruby-tuples
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Ruby implementation for tuples known from functional programming
+test_files: []