typed_map 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 092755b6e9e3f9778c4c20756959b48d9f4ac4f9
+  data.tar.gz: 76c5d56be0cb22bad9f1b4098549f63240bd810c
+SHA512:
+  metadata.gz: 1e86bcfbc64b9d1fdfac3107f536fbda61788709c4ee6c054e607a169a452612964d017f87123399ff79e4f5942bba81161eaab8aca4b156890f51a0456921bb
+  data.tar.gz: e5d8087bb6ed099778cd677b50d43a9b9f4020510c405a22e483e04242b10cc891783ee8ee1971e9fc01b63b921abec6e374d7255ceba3c8d6815738ed92cf23

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in typed_map.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Vladimir Melnik
+
+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,44 @@
+# TypedMap
+
+TypedMap is a Hash with typed keys and values.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'typed_map'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install typed_map
+
+## Usage
+
+TypedMap is a very simple data structure. It provides only 4 methods that are described below:
+
+```ruby
+pathes = TypedMap.new ktype: Symbol, vtype: String
+
+pathes.add :root, "/"
+pathes.add "key", "val" # Error
+pathes.add :key, :val   # Error
+
+pathes.has? :root # => true
+pathes.keys       # => [:root]
+pathes[:root]     # => "/"
+
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/typed_map/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,2 @@
+require "bundler/gem_tasks"
+

data/lib/typed_map/version.rb

@@ -0,0 +1,3 @@
+class TypedMap
+  VERSION = "0.0.1"
+end

data/lib/typed_map.rb

@@ -0,0 +1,40 @@
+require "typed_map/version"
+
+class TypedMap
+  attr_reader :ktype, :vtype
+
+  def initialize(ktype:, vtype:)
+    raise ArgumentError, "'ktype' should be an instance of Class" unless ktype.instance_of?(Class)
+    raise ArgumentError, "'vtype' should be an instance of Class" unless vtype.instance_of?(Class)
+
+    @ktype = ktype
+    @vtype = vtype
+
+    @map = {}
+  end
+
+  def add(k, v)
+    raise ArgumentError, "'k' should be an instance of #{ktype}" unless k.instance_of?(ktype)
+    raise ArgumentError, "'v' should be an instance of #{vtype}" unless v.instance_of?(vtype)
+    raise ArgumentError, "key '#{k}' already exists"             if has?(k)
+
+    @map[k] = v
+  end
+
+  def keys
+    @map.keys
+  end
+
+  def [](k)
+    raise ArgumentError, "'k' should be an instance of #{ktype}" unless k.instance_of?(ktype)
+    raise ArgumentError, "key '#{k}' not exists"                 unless has?(k)
+
+    @map[k]
+  end
+
+  def has?(k)
+    raise ArgumentError, "'k' should be an instance of #{ktype}" unless k.instance_of?(ktype)
+
+    @map.has_key? k
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require "./lib/typed_map"
+
+RSpec.configure do |config|
+  config.disable_monkey_patching!
+  config.expect_with :rspec
+
+  config.profile_examples = true
+  config.fail_fast = true
+  config.order = :rand
+end

data/spec/typed_map_spec.rb

@@ -0,0 +1,147 @@
+RSpec.describe TypedMap do
+  describe "class" do
+    subject { described_class }
+
+    describe ".new" do
+      context "when with good args" do
+        it "returns typed map" do
+          expect(subject.new ktype: Symbol, vtype: Symbol).to be_instance_of described_class
+          expect(subject.new ktype: Bignum, vtype: String).to be_instance_of described_class
+          expect(subject.new ktype: Hash, vtype: Array).to    be_instance_of described_class
+        end
+      end
+
+      context "when with bad args" do
+        it "raises ArgumentError" do
+          expect { subject.new }.to                                raise_error(ArgumentError).with_message("missing keywords: ktype, vtype")
+          expect { subject.new ktype: nil }.to                     raise_error(ArgumentError).with_message("missing keyword: vtype")
+          expect { subject.new vtype: nil }.to                     raise_error(ArgumentError).with_message("missing keyword: ktype")
+          expect { subject.new ktype: Symbol }.to                  raise_error(ArgumentError).with_message("missing keyword: vtype")
+          expect { subject.new vtype: Symbol }.to                  raise_error(ArgumentError).with_message("missing keyword: ktype")
+          expect { subject.new ktype: Symbol, vtype: nil }.to      raise_error(ArgumentError).with_message("'vtype' should be an instance of Class")
+          expect { subject.new ktype: nil, vtype: Symbol }.to      raise_error(ArgumentError).with_message("'ktype' should be an instance of Class")
+          expect { subject.new ktype: Symbol, vtype: nil }.to      raise_error(ArgumentError).with_message("'vtype' should be an instance of Class")
+          expect { subject.new ktype: true, vtype: Symbol }.to     raise_error(ArgumentError).with_message("'ktype' should be an instance of Class")
+          expect { subject.new ktype: Math, vtype: Enumerable }.to raise_error(ArgumentError).with_message("'ktype' should be an instance of Class")
+        end
+      end
+    end
+  end
+
+  describe "instance" do
+    subject { described_class.new ktype: Symbol, vtype: String }
+
+    describe "#[]" do
+      context "when good args" do
+        context "when element by given key exists" do
+          before { subject.add :key, "value" }
+
+          it "returns the coresponding value" do
+            expect(subject[:key]).to eq "value"
+          end
+        end
+
+        context "when element by given key doesn't exist" do
+          it "raises ArgumentError" do
+            expect { subject[:bad_key] }.to raise_error(ArgumentError).with_message("key 'bad_key' not exists")
+          end
+        end
+      end
+
+      context "when bad args" do
+        before { subject.add :key, "value" }
+
+        it "returns ArgumentError" do
+          expect { subject[] }.to      raise_error(ArgumentError).with_message("wrong number of arguments (0 for 1)")
+          expect { subject[nil] }.to   raise_error(ArgumentError).with_message("'k' should be an instance of Symbol")
+          expect { subject[true] }.to  raise_error(ArgumentError).with_message("'k' should be an instance of Symbol")
+          expect { subject["key"] }.to raise_error(ArgumentError).with_message("'k' should be an instance of Symbol")
+        end
+      end
+    end
+
+    describe "#keys" do
+      context "when empty" do
+        it "returns an empty array" do
+          expect(subject.keys).to eq []
+        end
+      end
+
+      context "when has one key-value pair" do
+        before { subject.add :key1, "value" }
+
+        it "returns an array with key" do
+          expect(subject.keys).to eq [:key1]
+        end
+      end
+
+      context "when has many key-value pairs" do
+        before do
+          subject.add :key1, "value"
+          subject.add :key2, "value"
+        end
+
+        it "returns an array with key" do
+          expect(subject.keys).to eq [:key1, :key2]
+        end
+      end
+    end
+
+    describe "#add" do
+      context "when good args" do
+        context "when new key" do
+          it "adds new key-value pair" do
+            expect { subject.add :key, "value" }.to change { subject.has? :key }.from(false).to(true)
+            expect(subject[:key]).to eq "value"
+          end
+        end
+
+        context "when key already exists" do
+          before { subject.add :key, "value" }
+
+          it "raises ArgumentError" do
+            expect { subject.add :key, "value" }.to raise_error(ArgumentError).with_message("key 'key' already exists")
+          end
+        end
+      end
+
+      context "when bad args" do
+        it "raises ArgumentError" do
+          expect { subject.add }.to                raise_error(ArgumentError).with_message("wrong number of arguments (0 for 2)")
+          expect { subject.add :key }.to           raise_error(ArgumentError).with_message("wrong number of arguments (1 for 2)")
+          expect { subject.add nil, nil }.to       raise_error(ArgumentError).with_message("'k' should be an instance of Symbol")
+          expect { subject.add nil, "value" }.to   raise_error(ArgumentError).with_message("'k' should be an instance of Symbol")
+          expect { subject.add "key", "value" }.to raise_error(ArgumentError).with_message("'k' should be an instance of Symbol")
+          expect { subject.add :key, nil }.to      raise_error(ArgumentError).with_message("'v' should be an instance of String")
+          expect { subject.add :key, :value}.to    raise_error(ArgumentError).with_message("'v' should be an instance of String")
+        end
+      end
+    end
+
+    describe "#has?" do
+      context "when good args" do
+        context "when key exists" do
+          before { subject.add :key, "value" }
+
+          it "returns true" do
+            expect(subject.has? :key).to be true
+          end
+        end
+
+        context "when key doesn't exist" do
+          it "returns false" do
+            expect(subject.has? :key).to be false
+          end
+        end
+      end
+
+      context "when bad args" do
+        it "raises ArgumentError" do
+          expect { subject.has? }.to       raise_error(ArgumentError).with_message("wrong number of arguments (0 for 1)")
+          expect { subject.has? nil }.to   raise_error(ArgumentError).with_message("'k' should be an instance of Symbol")
+          expect { subject.has? "key" }.to raise_error(ArgumentError).with_message("'k' should be an instance of Symbol")
+        end
+      end
+    end
+  end
+end

data/typed_map.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'typed_map/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "typed_map"
+  spec.version       = TypedMap::VERSION
+  spec.authors       = ["Vladimir Melnik"]
+  spec.email         = ["egotraumatic@gmail.com"]
+  spec.summary       = %q{TypedMap is a Hash with typed keys and values.}
+  spec.description   = %q{TypedMap is a Hash with typed keys and values.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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.7"
+  spec.add_development_dependency "rake",         "~> 10.0"
+  spec.add_development_dependency "rspec",        "~> 3.3"
+  spec.add_development_dependency "mutant-rspec", "~> 0.8"
+  spec.add_development_dependency "guard-rspec",  "~> 4.6"
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: typed_map
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Vladimir Melnik
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: mutant-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.6'
+description: TypedMap is a Hash with typed keys and values.
+email:
+- egotraumatic@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/typed_map.rb
+- lib/typed_map/version.rb
+- spec/spec_helper.rb
+- spec/typed_map_spec.rb
+- typed_map.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.5.1
+signing_key: 
+specification_version: 4
+summary: TypedMap is a Hash with typed keys and values.
+test_files:
+- spec/spec_helper.rb
+- spec/typed_map_spec.rb
+has_rdoc: