triad 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b102ba1a28f4a9bf80e239083ec5cfa6ecfa02cd
+  data.tar.gz: a2fbdcae55dae2126fdc315060bc2f9109b7a2aa
+SHA512:
+  metadata.gz: 42e73cadff398ec9c7c751be0f4492990b0b2f7ac122694d750684ded08511f1f60e8a3addad520a61d2bf18e10a1467f23c4b3a13d88d9c037cac0610b278d5
+  data.tar.gz: eef77531a5080e84015c3c2664dba5f3222107a9d7c2b4139dcc21814deec4117827657706b8f968c42952fe69df33bdf1e3f45057f9e6a679b61c1c4e184a81

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - jruby-19mode # JRuby in 1.9 mode
+  - ruby-head
+  - jruby-head
+  - rbx-19mode
+env:
+- COVERALLS=true
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head
+    - rvm: rbx-19mode

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in triad.gemspec
+gemspec
+
+group :test do
+  gem "rake"
+  gem "simplecov"
+  gem "minitest"
+  gem "coveralls"
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 'Jim Gay'
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,61 @@
+# Triad
+
+[![Build Status](https://travis-ci.org/saturnflyer/triad.png?branch=master)](https://travis-ci.org/saturnflyer/triad)
+[![Code Climate](https://codeclimate.com/github/saturnflyer/triad.png)](https://codeclimate.com/github/saturnflyer/triad)
+[![Coverage Status](https://coveralls.io/repos/saturnflyer/triad/badge.png)](https://coveralls.io/r/saturnflyer/triad)
+[![Gem Version](https://badge.fury.io/rb/triad.png)](http://badge.fury.io/rb/triad)
+
+A Triad is like a Set, or a collection of three-part arrays.
+
+A Triad is a collection of items each with a `key`, `descriptor`, and `value`.
+
+Each `key` must be a unique symbol.
+Each `descriptor` must be a string.
+Each `value` must not be a symbol nor a string.
+
+```ruby
+user = Object.new
+
+map = Triad.new
+map << [:admin, 'Admin', user]
+
+map.keys('Admin') #=> [:admin]
+map.values('Admin') #=> [user]
+map.descriptors('Admin') #=> ['Admin'] or raise DescriptorNotPresent
+
+map.descriptors(user) #=> ['Admin']
+map.keys(user) #=> [:admin]
+map.values(user) #=> [user] or raise ValueNotPresent
+
+map.values(:admin) #=> [user]
+map.descriptors(:admin) #=> ['Admin']
+map.keys(:admin) #=> [:admin] or raise KeyNotPresent
+
+map.each do |key, descriptor, value|
+  #...
+end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'triad'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install triad
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/lib/triad/version.rb

@@ -0,0 +1,3 @@
+class Triad
+  VERSION = "0.1.0"
+end

data/lib/triad.rb

@@ -0,0 +1,87 @@
+require "triad/version"
+
+class Triad
+  include Enumerable
+
+  class InvalidAddition < StandardError
+    def message
+      "your array length must be 3"
+    end
+  end
+  class ValueNotPresent < StandardError; end
+  class DescriptorNotPresent < StandardError; end
+  class KeyNotPresent < StandardError; end
+
+  # stored as {key => ['Descriptor', value]}
+  def initialize(*args)
+    @storage = {}
+  end
+  attr_reader :storage
+  private :storage
+
+  def keys(arg)
+    with_interest(arg).map{|key, _, _| key }
+  end
+
+  def descriptors(arg)
+    with_interest(arg).map{|_, descriptor, _| descriptor }
+  end
+
+  def values(arg)
+    with_interest(arg).map{|_, _, value| value }
+  end
+
+  def <<(array)
+    array_key = array.find{|item| item.is_a?(Symbol) }
+    raise InvalidAddition if array.length != 3 || key_exists?(array_key)
+
+    array_descriptor = array.find{|item| item.is_a?(String) }
+    array_value =      array.find{|item| !item.is_a?(String) && !item.is_a?(Symbol) }
+
+    storage[array_key] = [array_descriptor, array_value]
+    self
+  end
+
+  def each
+    storage.each do |key, (descriptor, value)|
+      yield key, descriptor, value
+    end
+  end
+
+  private
+
+  def key_exists?(key)
+    storage.has_key?(key)
+  end
+
+  def positions
+    [:key, :descriptor, :value]
+  end
+
+  def argument_type(arg)
+    case arg
+    when Symbol then :key
+    when String then :descriptor
+    else :value
+    end
+  end
+
+  def raise_error(type)
+    error_name = type.to_s.gsub(/(?:^|_)([a-z])/) { $1.upcase }
+    error_class = Triad.const_get("#{error_name}NotPresent")
+    raise error_class.new
+  end
+
+  def with_interest(interest)
+    type = argument_type(interest)
+    index = positions.index(type)
+
+    lookup = storage.select{|key, array|
+      [key, *array][index] == interest
+    }.map{|key, array| [key, *array] }
+
+    raise_error(type) if lookup.empty?
+
+    lookup
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,13 @@
+require 'simplecov'
+SimpleCov.start do
+  add_filter 'test'
+end
+require 'coveralls'
+
+if ENV['COVERALLS']
+  Coveralls.wear!
+end
+
+require 'minitest/autorun'
+
+require 'triad'

data/test/triad_test.rb

@@ -0,0 +1,173 @@
+require 'test_helper'
+
+describe Triad, '#<<' do
+  let(:triad){ Triad.new }
+
+  it 'shovels 3 item arrays' do
+    assert triad << [:test, 'Test', Object.new]
+  end
+
+  it 'rejects arrays with more than 3 items' do
+    error = assert_raises(Triad::InvalidAddition){
+      triad << [:test, 'Test', Object.new, 'Other']
+    }
+    assert_match /array length must be 3/, error.message
+  end
+
+  it 'rejects arrays with fewer than 3 items' do
+    assert_raises(Triad::InvalidAddition){
+      triad << [:test, 'Test']
+    }
+  end
+
+  it 'rejects arrays with an existing key' do
+    triad << [:test, 'Test', Object.new]
+    assert_raises(Triad::InvalidAddition){
+      triad << [:test, 'More', Object.new]
+    }
+  end
+
+  it 'assigns symbol as key' do
+    object = Object.new
+    triad << ['OutOfOrder', object, :surprise]
+    assert_equal [:surprise], triad.keys('OutOfOrder')
+    assert_equal [:surprise], triad.keys(object)
+  end
+
+  it 'assigns string as descriptor' do
+    object = Object.new
+    triad << ['OutOfOrder', object, :surprise]
+    assert_equal ['OutOfOrder'], triad.descriptors(:surprise)
+    assert_equal ['OutOfOrder'], triad.descriptors(object)
+  end
+
+  it 'assigns non-symbol, non-string objects as value' do
+    object = Object.new
+    triad << ['OutOfOrder', object, :surprise]
+    assert_equal [object], triad.values(:surprise)
+    assert_equal [object], triad.values('OutOfOrder')
+  end
+end
+
+describe Triad, '#keys' do
+  let(:user){ Object.new }
+  let(:triad){
+    tri = Triad.new
+    tri << [:admin, 'Admin', user]
+    tri
+  }
+
+  it 'returns the key for the given descriptor' do
+    assert_equal [:admin], triad.keys('Admin')
+  end
+
+  it 'returns the key for the given value' do
+    assert_equal [:admin], triad.keys(user)
+  end
+
+  it 'returns the keys for the given key' do
+    assert_equal [:admin], triad.keys(:admin)
+  end
+
+  it 'errors when the given key is not found' do
+    assert_raises(Triad::KeyNotPresent){
+      triad.keys(:invalid_key)
+    }
+  end
+
+  it 'errors when the given descriptor is not found' do
+    assert_raises(Triad::DescriptorNotPresent){
+      triad.keys('Invalid Descriptor')
+    }
+  end
+
+  it 'errors when the given value is not found' do
+    assert_raises(Triad::ValueNotPresent){
+      triad.keys(Object.new)
+    }
+  end
+end
+
+describe Triad, '#descriptors' do
+  let(:user){ Object.new }
+  let(:triad){
+    tri = Triad.new
+    tri << [:admin, 'Admin', user]
+    tri
+  }
+
+  it 'returns the descriptor for the given key' do
+    assert_equal ['Admin'], triad.descriptors(:admin)
+  end
+
+  it 'returns the descriptor for the given value' do
+    assert_equal ['Admin'], triad.descriptors(user)
+  end
+
+  it 'returns the descriptors for the given descriptor' do
+    assert_equal ['Admin'], triad.descriptors('Admin')
+  end
+
+  it 'errors when the given descriptor is not found' do
+    assert_raises(Triad::DescriptorNotPresent){
+      triad.descriptors('Not Present')
+    }
+  end
+
+  it 'errors when the given key is not found' do
+    assert_raises(Triad::KeyNotPresent){
+      triad.descriptors(:invalid_key)
+    }
+  end
+
+  it 'errors when the given value is not found' do
+    assert_raises(Triad::ValueNotPresent){
+      triad.descriptors(Object.new)
+    }
+  end
+end
+
+describe Triad, '#values' do
+  let(:user){ Object.new }
+  let(:triad){
+    tri = Triad.new
+    tri << [:admin, 'Admin', user]
+    tri
+  }
+
+  it 'returns the value for the given key' do
+    assert_equal [user], triad.values(:admin)
+  end
+
+  it 'returns the value for the given descriptor' do
+    assert_equal [user], triad.values('Admin')
+  end
+
+  it 'errors when the given key is not found' do
+    assert_raises(Triad::KeyNotPresent){
+      triad.values(:invalid_key)
+    }
+  end
+
+  it 'errors when the given descriptor is not found' do
+    assert_raises(Triad::DescriptorNotPresent){
+      triad.values('Invalid Descriptor')
+    }
+  end
+end
+
+describe Triad, 'enumeration' do
+  let(:user){ Object.new }
+  let(:triad){
+    tri = Triad.new
+    tri << [:admin, 'Admin', user]
+    tri
+  }
+  it 'yields each triad as 3 block variables' do
+    result = ''
+    triad.each do |key, descriptor, value|
+      result << "key: #{key}, descriptor: #{descriptor}, value: #{value.class.name}"
+    end
+    assert_equal 'key: admin, descriptor: Admin, value: Object', result
+  end
+end

data/triad.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'triad/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "triad"
+  spec.version       = Triad::VERSION
+  spec.authors       = ["'Jim Gay'"]
+  spec.email         = ["jim@saturnflyer.com"]
+  spec.description   = %q{Triad allows you to access data from keys, descriptors, and values}
+  spec.summary       = %q{Manage a collection with 3 data points}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: triad
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- '''Jim Gay'''
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Triad allows you to access data from keys, descriptors, and values
+email:
+- jim@saturnflyer.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/triad.rb
+- lib/triad/version.rb
+- test/test_helper.rb
+- test/triad_test.rb
+- triad.gemspec
+homepage: ''
+licenses:
+- MIT
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Manage a collection with 3 data points
+test_files:
+- test/test_helper.rb
+- test/triad_test.rb
+has_rdoc: