triad 0.3.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c509af042f22f2fb764c0d6218b0ed45d0cce53d
-  data.tar.gz: 5958c9b4e43aeba09e4956393918730a30c25189
+SHA256:
+  metadata.gz: 1506f956e5cf2624d48a561a54b55e6a421bd92f5542004eec34df90ebb814a7
+  data.tar.gz: a090e6814e78240b6081e7e5d6c730751d451c07411d01b9b6149cd84bd00d4e
 SHA512:
-  metadata.gz: 0bc285d97ec8e4f1418d27f53d5cec3822faf793e32a45871cbc2e84e6e403ddb01756864f56eb1d007555871dd10a03f0c7dc1d4bf88e9d247dd25fd3c58f18
-  data.tar.gz: e3f7700cc6f6410994b627c05a573c219df2ba41e055f99452a64499b98cb476a637be78bc674d6fe2adbad43d6b2a053cefa2a045fecfe1972b5ccdb26658c4
+  metadata.gz: 2d26ec61656145fcedc646b5dafdf0a1cff341cb74e9bee9592d99ed62d1db7e118ec9ed9e791dd85e96cdd7a3192a210a9763476f36d9e3f9cb7f7ee1b74b81
+  data.tar.gz: 7035ae759c39fd4b1abf78a63b3637d84d69f2dddb0b835e056e49a1a69727e98eb2e37d588f2e24e53fd004e244289d4c3bca562ae689da3e5bb0f23da986b5

data/Gemfile

@@ -2,8 +2,6 @@ source 'https://rubygems.org'
 
 gemspec
 
-group :test do
-  gem "simplecov"
-  gem "minitest"
-  gem "coveralls"
-end
+gem "rake"
+gem "simplecov"
+gem "minitest"

data/README.md

@@ -1,6 +1,5 @@
 # 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)

data/lib/triad/version.rb

@@ -1,3 +1,3 @@
 class Triad
-  VERSION = "0.3.0"
+  VERSION = "1.0.0"
 end

data/lib/triad.rb

@@ -14,22 +14,25 @@ class Triad
   attr_reader :storage
   private :storage
 
-  def keys(arg=:__no_argument_given__)
-    if arg == :__no_argument_given__
+  # Return the keys for a given descriptor or value
+  def keys(arg=nil)
+    if arg == nil
       storage.keys
     else
       with_interest(arg).map{|key, _, _| key }
     end
   end
 
-  def descriptors(arg=:__no_argument_given__)
-    if arg == :__no_argument_given__
+  # Return the descriptors for a given key or value
+  def descriptors(arg=nil)
+    if arg.nil?
       storage.map{|_,(descriptor,_)| descriptor }
     else
       with_interest(arg).map{|_, descriptor, _| descriptor }
     end
   end
 
+  # Return the values for a given key or descriptor
   def values(arg=:__no_argument_given__)
     if arg == :__no_argument_given__
       storage.map{|_,(_,value)| value }.uniq
@@ -38,40 +41,45 @@ class Triad
     end
   end
 
+  # Add new entries to the object
   def <<(array)
-    array_key = array[0]
     raise InvalidAddition.new("your array length must be 3") if array.length != 3
+    array_key = array.fetch(0)
+    raise InvalidAddition.new("the provided key must be a Symbol") unless array_key.is_a?(Symbol)
     raise InvalidAddition.new("the provided key already exists") if key_exists?(array_key)
 
-    array_descriptor = array[1]
-    array_value =      array[2]
+    array_descriptor = array.fetch(1)
+    raise InvalidAddition.new("the provided descriptor must be a String") unless array_descriptor.is_a?(String)
+    array_value =      array.fetch(2)
 
     storage[array_key] = [array_descriptor, array_value]
     self
   end
 
+  # Alter the descriptor and value in-place for the given key
   def update(key, descriptor, value)
+    raise InvalidAddition.new("the provided descriptor cannot be nil") if descriptor.nil?
     storage[key] = [descriptor, value]
   end
 
-  def each(&block)
+  def each
     storage.each do |key, (descriptor, value)|
-      block.call key, descriptor, value
+      yield key, descriptor, value
     end
   end
 
   private
 
   def key_exists?(key)
-    storage.has_key?(key)
+    storage.key?(key)
   end
-  
+
   def descriptor_exists?(descriptor)
-    storage.values.map{|arr| arr[0] }.include?(descriptor)
+    storage.values.map{|arr| arr.fetch(0) }.include?(descriptor)
   end
-  
+
   def value_exists?(value)
-    storage.values.map{|arr| arr[1] }.include?(value)
+    storage.values.map{|arr| arr.fetch(1) }.include?(value)
   end
 
   def with_interest(interest)

data/test/triad_test.rb

@@ -1,4 +1,4 @@
-require 'test_helper'
+require_relative 'test_helper'
 
 describe Triad, '#<<' do
   let(:triad){ Triad.new }
@@ -22,9 +22,10 @@ describe Triad, '#<<' do
 
   it 'rejects arrays with an existing key' do
     triad << [:test, 'Test', Object.new]
-    assert_raises(Triad::InvalidAddition){
+    error = assert_raises(Triad::InvalidAddition){
       triad << [:test, 'More', Object.new]
     }
+    assert_match(/key already exists/, error.message)
   end
   
   it 'accepts strings as values' do
@@ -32,6 +33,20 @@ describe Triad, '#<<' do
     triad << [:key, 'Descriptor', object]
     assert_equal [object], triad.values(:key)
   end
+
+  it "rejects keys that are not Symbols" do
+    error = assert_raises(Triad::InvalidAddition){
+      triad << ["key", "Descriptor", Object.new]
+    }
+    assert_match(/must be a Symbol/, error.message)
+  end
+
+  it "rejects descriptors that are not Strings" do
+    error = assert_raises(Triad::InvalidAddition){
+      triad << [:key, :Descriptor, Object.new]
+    }
+    assert_match(/must be a String/, error.message)
+  end
 end
 
 describe Triad, '#update' do
@@ -44,6 +59,20 @@ describe Triad, '#update' do
     triad.update(:test, 'Updated', Object.new)
     assert_equal ['Updated'], triad.descriptors(:test)
   end
+
+  it "allows a nil object" do
+    triad << [:test, 'Test', nil]
+    assert_equal ['Test'], triad.descriptors(:test)
+    triad.update(:test, 'Updated', nil)
+    assert_equal ['Updated'], triad.descriptors(:test)
+  end
+
+  it "does not allow a nil descriptor" do
+    err = assert_raises(Triad::InvalidAddition){
+      triad.update(:test, nil, Object.new)
+    }
+    assert_equal "the provided descriptor cannot be nil", err.message
+  end
 end
 
 describe Triad, '#keys' do
@@ -132,6 +161,11 @@ describe Triad, '#descriptors' do
       triad.descriptors(Object.new)
     }
   end
+
+  it 'assumes nil is a value' do
+    triad.update(:admin, 'Admin', nil)
+    assert_equal ['Admin'], triad.descriptors(:admin)
+  end
 end
 
 describe Triad, '#values' do
@@ -183,4 +217,4 @@ describe Triad, 'enumeration' do
     end
     assert_equal 'key: admin, descriptor: Admin, value: Object', result
   end
-end
+end

data/triad.gemspec

@@ -10,16 +10,13 @@ Gem::Specification.new do |spec|
   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.homepage      = "https://github.com/saturnflyer/triad"
   spec.license       = "MIT"
 
-  spec.files         = `git ls-files`.split($/)
+  spec.files         = Dir['lib/**/*'] + %w[ Gemfile LICENSE.txt README.md Rakefile triad.gemspec test/triad_test.rb ]
   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_dependency "concurrent-ruby", "> 0.9"
-
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: triad
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.0
 platform: ruby
 authors:
 - "'Jim Gay'"
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-06-07 00:00:00.000000000 Z
+date: 2022-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -24,34 +24,6 @@ dependencies:
     - - ">"
       - !ruby/object:Gem::Version
         version: '0.9'
-- !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
@@ -59,22 +31,19 @@ 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: ''
+homepage: https://github.com/saturnflyer/triad
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -89,12 +58,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.3.17
+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: 

data/.gitignore

@@ -1,17 +0,0 @@
-*.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

@@ -1,16 +0,0 @@
-before_install:
-  - gem install bundler
-language: ruby
-cache: bundler
-rvm:
-  - 2.3.1
-  - 2.2.5
-  - 2.1.10
-  - ruby-head
-  - jruby-head
-env:
-- COVERALLS=true
-matrix:
-  allow_failures:
-    - rvm: ruby-head
-    - rvm: jruby-head

data/test/test_helper.rb

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