typed_array 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 51df2a5bdd1bf2ef18e2d930fded2af9434367b7bfc29312bd3538a3b8d5cf71
+  data.tar.gz: 22dbcfe75d718da1528a19a388b41d7c7b03552737354931bf8a5575b874cfad
+SHA512:
+  metadata.gz: 851e90ba45588b231d456730308f504db1b7d135a58879873a305717599460c280234750847c9ed56cc366df209276926274599cc137b25281be828ba6367cd4
+  data.tar.gz: 3568614e4cffe9eff314a31a25597c4fbd491fba7e700108ffd3b6863db41fca68f0cef1090911f95b79fa390b9b51e1881484e06faf176e724072c17a6ef1d8

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.8
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in typed_array.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    typed_array (1.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  typed_array!
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Alexander Koltun
+
+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,116 @@
+# TypedArray
+
+This gem provides new type `TypedArray` which is direct successor of ruby `Array` class. 
+`TypedArray` requires to specify a type of its elements and allows to add only elements of this type.  
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'typed_array'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install typed_array
+
+## Usage
+
+### Creation
+
+`TypedArray` has a read-only attribute `:item_class` which specifies the class of its elements.
+Any attempt to add elements of different class will cause `ArgumentError` exception with corresponding message.
+ 
+`TypedArray` instance can be created in the same way as ordinary `Array`. 
+If it is created from the list of elements than the class of first non-nil element
+is considered as `:item_class` and all other elements should be either of the same class or `nil`.
+
+```ruby
+ta = TypedArray[nil, 1, 2, 3]   # => [nil, 1, 2, 3]
+ta.item_class                   # => Fixnum
+ta << 5                         # => [nil, 1, 2, 3, 5]
+ta << :a                        # ArgumentError: assigned item(s) should be of the type Fixnum
+ta << nil                       # => [nil, 1, 2, 3, 5, nil]
+
+ta = TypedArray[1, :a, 'b']     # ArgumentError: all arguments should be of the same type
+
+ta = TypedArray[nil, nil]       # ArgumentError: [] constructor requires at least one non-nil element
+```
+
+If it is created without elements than the first argument of constructor call should be the class of its future elements. 
+
+```ruby
+ta = TypedArray.new(Fixnum)     # []
+ta.item_class                   # => Fixnum
+ta << nil                       # => [nil]
+ta << 1                         # => [nil, 1] 
+ta << :a                        # ArgumentError: assigned item(s) should be of the type Fixnum
+```
+
+### Comparison
+
+Two `TypedArray`s are considered as equal if and only if both of them have the same `:item_class` and elements.
+`TypedArray` is considered as equal (in terms of :== operator) to an ordinary `Array` if they have the same elements.
+`TypedArray` is always considered as non-equal (in terms of :eql? operator) to an ordinary `Array`.
+
+```ruby
+TypedArray[1, 2, 3] == TypedArray[1, 2, 3]        # => true
+TypedArray[1, 2, 3] == TypedArray[1, 2, 4]        # => false
+TypedArray.new(Fixnum) == TypedArray.new(Fixnum)  # => true 
+TypedArray.new(Fixnum) == TypedArray.new(Symbol)  # => false
+TypedArray[1, 2, 3] == [1, 2, 3]                  # => true
+TypedArray[1, 2, 3] == [1, 2, 4]                  # => false
+TypedArray.new(Fixnum) == []                      # => true 
+TypedArray[1, 2, 3].eql? TypedArray[1, 2, 3]      # => true
+TypedArray[1, 2, 3].eql? [1, 2, 3]                # => false
+```
+
+### Inherited Array behaviour
+
+All `Array` methods that are supposed to return an array/slice of elements of original array will returns `TypedArray` in case of `TypedArray`.
+```ruby
+TypedArray[1, 2, 3][1..2]                               # => [2, 3]
+TypedArray[1, 2, 3][1..2].class                         # => TypedArray
+TypedArray[1, 2, 3][1..2].item_class                    # => Fixnum
+```
+
+Any operations between `TypedArray`s with the same `:item_class` will return `TypedArray`. 
+Any operations between `TypedArray`s with different `:item_class`es will return `Array`. 
+Any operations between `TypedArray` and `Array` will return `Array`. 
+
+```ruby
+TypedArray[1, 2, 3]  | TypedArray[2, 4]                 # => [1, 2, 3, 4]
+(TypedArray[1, 2, 3] | TypedArray[2, 4]).class          # => TypedArray
+(TypedArray[1, 2, 3] | TypedArray[2, 4]).item_class     # => Fixnum
+
+TypedArray[1, 2, 3]  | TypedArray[:a, :b]               # => [1, 2, 3, :a, :b]
+(TypedArray[1, 2, 3] | TypedArray[:a, :b]).class        # => Array
+(TypedArray[1, 2, 3] | TypedArray[:a, :b]).item_class   # NoMethodError: undefined method `item_class' for [1, 2, 3, :a, :b]:Array
+
+TypedArray[1, 2, 3]  | [2, 4]                           # => [1, 2, 3, 4]
+(TypedArray[1, 2, 3] | [2, 4]).class                    # => Array
+(TypedArray[1, 2, 3] | [2, 4]).item_class               # NoMethodError: undefined method `item_class' for [1, 2, 3, :a, :b]:Array
+
+TypedArray[1, 2, 3]  | [:a, :b]                         # => [1, 2, 3, :a, :b]
+(TypedArray[1, 2, 3] | [:a, :b]).class                  # => Array
+(TypedArray[1, 2, 3] | [:a, :b]).item_class             # NoMethodError: undefined method `item_class' for [1, 2, 3, :a, :b]:Array
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also 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`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/akoltun/typed_array.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "typed_array"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/typed_array/version.rb

@@ -0,0 +1,3 @@
+class TypedArray < Array
+  VERSION = "1.0.1"
+end

data/lib/typed_array.rb

@@ -0,0 +1,241 @@
+require "typed_array/version"
+
+class TypedArray < Array
+  attr_reader :item_class
+
+  def self.[](*args)
+    klasses = args.compact.map(&:class).uniq
+    raise ArgumentError, '[] constructor requires at least one non-nil element' if klasses.empty?
+    raise ArgumentError, 'all arguments should be of the same type' if klasses.size > 1
+    self.new(klasses.first).push(*args)
+  end
+
+  def initialize(item_class, *args)
+    @item_class = item_class
+    super(*args)
+  end
+
+  def ==(item)
+    (!item.is_a?(TypedArray) || item_class == item.item_class) && super
+  end
+
+  def eql?(item)
+    item.is_a?(TypedArray) && item_class == item.item_class && super
+  end
+
+  def [](*args)
+    if args.size == 2 || (args.size == 1 && args.first.is_a?(Range))
+      self.class.new(item_class).push(*super)
+    else
+      super
+    end
+  end
+
+  def []=(*args)
+    if (args.size == 3 || (args.size == 2 && args.first.is_a?(Range))) && args.last.is_a?(Array)
+      validate_assigned_items(args.last)
+    else
+      validate_assigned_items([args.last])
+    end
+
+    super
+  end
+
+  def concat(items)
+    validate_assigned_items(items)
+    super
+  end
+
+  def <<(item)
+    validate_assigned_items([item])
+    super
+  end
+
+  def insert(index, *items)
+    validate_assigned_items(items)
+    super
+  end
+
+  def push(*items)
+    validate_assigned_items(items)
+    super
+  end
+
+  def unshift(*items)
+    validate_assigned_items(items)
+    super
+  end
+
+  def pop(*args)
+    if args.size > 0
+      TypedArray.new(item_class).concat(super)
+    else
+      super
+    end
+  end
+
+  def shift(*args)
+    if args.size > 0
+      TypedArray.new(item_class).concat(super)
+    else
+      super
+    end
+  end
+
+  def reverse
+    TypedArray.new(item_class).concat(super)
+  end
+
+  def rotate(count=1)
+    TypedArray.new(item_class).concat(super)
+  end
+
+  def sort(*args)
+    TypedArray.new(item_class).concat(super)
+  end
+
+  def sort_by(&block)
+    if block_given?
+      TypedArray.new(item_class).concat(super)
+    else
+      super
+    end
+  end
+
+  def select(&block)
+    if block_given?
+      TypedArray.new(item_class).concat(super)
+    else
+      super
+    end
+  end
+
+  def values_at(*args)
+    TypedArray.new(item_class).concat(super)
+  end
+
+  def reject(&block)
+    if block_given?
+      TypedArray.new(item_class).concat(super)
+    else
+      super
+    end
+  end
+
+  def replace(items)
+    validate_assigned_items(items)
+    super
+  end
+
+  def fill(*args, &block)
+    if block_given?
+      super(*args) do |index|
+        value = block.call(index)
+        validate_assigned_items([value])
+        value
+      end
+    else
+      validate_assigned_items([args.first])
+      super
+    end
+  end
+
+  def slice(*args)
+    copy_item_class(super)
+  end
+
+  def slice!(*args)
+    copy_item_class(super)
+  end
+
+  def +(items)
+    validate_assigned_items(items)
+    TypedArray.new(item_class).concat(super)
+  end
+
+  def *(*args)
+    copy_item_class(super)
+  end
+
+  def -(items)
+    TypedArray.new(item_class).concat(super)
+  end
+
+  def &(items)
+    TypedArray.new(item_class).concat(super)
+  end
+
+  def |(items)
+    if items.is_a?(TypedArray) && items.item_class == item_class
+      TypedArray.new(item_class).concat(super)
+    else
+      super
+    end
+  end
+
+  def uniq(&block)
+    copy_item_class(super)
+  end
+
+  def compact
+    TypedArray.new(item_class).concat(super)
+  end
+
+  def shuffle(*args)
+    TypedArray.new(item_class).concat(super)
+  end
+
+  def sample(*args)
+    if args.size > 0 && !args.first.is_a?(Hash)
+      TypedArray.new(item_class).concat(super)
+    else
+      super
+    end
+  end
+
+  def product(*args)
+    if args.all? { |items| items.is_a?(TypedArray) && items.item_class == item_class }
+      super.map { |items| TypedArray.new(item_class).concat(items) }
+    else
+      super
+    end
+  end
+
+  def take(*args)
+    TypedArray.new(item_class).concat(super)
+  end
+
+  def take_while(&block)
+    if block_given?
+      TypedArray.new(item_class).concat(super)
+    else
+      super
+    end
+  end
+
+  def drop(*args)
+    TypedArray.new(item_class).concat(super)
+  end
+
+  def drop_while(&block)
+    if block_given?
+      TypedArray.new(item_class).concat(super)
+    else
+      super
+    end
+  end
+
+  private
+
+  def validate_assigned_items(items)
+    unless items.all? { |item| item.nil? || item.class == item_class }
+      raise ArgumentError, "assigned item(s) should be of the type #{item_class}"
+    end
+  end
+
+  def copy_item_class(typed_array)
+    typed_array.instance_variable_set(:@item_class, item_class) if typed_array.is_a? TypedArray
+    typed_array
+  end
+
+end

data/typed_array.gemspec

@@ -0,0 +1,35 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "typed_array/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "typed_array"
+  spec.version       = TypedArray::VERSION
+  spec.authors       = ["Alexander Koltun"]
+  spec.email         = ["alexander.koltun@gmail.com"]
+
+  spec.summary       = %q{Array with element strict typing}
+  spec.homepage      = "https://github.com/akoltun/typed_array"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: typed_array
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Alexander Koltun
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-04-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- alexander.koltun@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/typed_array.rb
+- lib/typed_array/version.rb
+- typed_array.gemspec
+homepage: https://github.com/akoltun/typed_array
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Array with element strict typing
+test_files: []