generics 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 32d9829502d2007dbb1e266845feacb2a40cb2fc
+  data.tar.gz: bbe0440878cb87b22eb84aefc68e370c88db2fa0
+SHA512:
+  metadata.gz: 64257de2064f629fc083cb3051517a60ce60dfa8e7ec761e88940ad2c44b97692994099cfccfd8de77dbb3b5bc6df68bfc039acd728147068ef5606d74bb6db7
+  data.tar.gz: 44f0a610c9506da1ebd643ac39c37b99d970cc551c3fd69edf4f72fa93a9e10da775da115b2ab391dd809acaf1651b5e3ce6c32a2b3701a605c4d31765d335d5

data/.gitignore

@@ -0,0 +1,13 @@
+*.sublime-project
+*.sublime-workspace
+/*.gem
+/.bundle/
+/.yardoc/
+/coverage/
+/doc/
+/Gemfile.lock
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/cache
+/vendor/ruby

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at geoff.lee@lendesk.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 
+
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 matrinox
+
+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,63 @@
+# Generics
+
+The philosophy here is to bring as much modern language features that help developers code better, safer, and more reliably. Here are some top priorities of this library:
+
+- Immutability first with mutability as an option (e.g for speed)
+- Type safety
+- Follow functional practices
+- Use standard interfaces of Ruby
+- Fail early, throw fast
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'generics'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install generics
+
+## Usage
+
+```ruby
+list_of_ints = Generics::List[Integer].new(1, 2, 3, 4)
+list_of_ints.add(5) # ok
+list_of_ints.add('6') # NotSameType exception
+list_of_ints.count # 4 (immutable)
+list_of_ints.add(5).add(6).add(7).count # 7
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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).
+
+## TODO
+
+- Other collection types (at least the same list as core ruby data types and the Hamster immutable library)
+- More complex generics
+  - Responds to generics (another form of duck type, though modules are preferable)
+  - Array generics (e.g. list of strings)
+  - Hash generics (e.g. keys are numbers and values are list of strings)
+  - Either/enums (e.g. list of strings or integers of anything that responds to :x). This would require either adopting a library or creating one ourselves as a separate gem
+- Generics in functions/closures
+- Generics in methods
+- Generics in classes
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/generics. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler/gem_tasks'
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'generics'
+
+# 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

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/generics.gemspec

@@ -0,0 +1,47 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'generics/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'generics'
+  spec.version       = Generics::VERSION
+  spec.authors       = ['matrinox']
+  spec.email         = ['geoff.lee@lendesk.com']
+
+  spec.summary       = %q{Generics for Ruby}
+  spec.description   = %q{Generics for Ruby, starting with collections}
+  spec.homepage      = 'https://github.com/matrinox/generics'
+  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 { |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.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+
+  # Fun pry tools
+  spec.add_development_dependency 'awesome_print', '~> 1.6.1'
+  spec.add_development_dependency 'pry', '~> 0.10.4'
+  spec.add_development_dependency 'pry-byebug', '~> 3.3.0'
+  spec.add_development_dependency 'pry-coolline', '~> 0.2.5'
+  spec.add_development_dependency 'pry-rails', '~> 0.3.4'
+  spec.add_development_dependency 'pry-toys', '~> 0.0.2'
+  spec.add_development_dependency 'pry-macro', '~> 1.0.1'
+  spec.add_development_dependency 'pry-state', '~> 0.1.7'
+  spec.add_development_dependency 'pry-inline', '~> 1.0.1'
+  spec.add_development_dependency 'pry-doc', '~> 0.9.0'
+  spec.add_development_dependency 'pry-highlight', '~> 0.1.0'
+
+  spec.add_dependency 'hamster', '>= 3.0.0'
+end

data/lib/generics.rb

@@ -0,0 +1,7 @@
+require 'generics/version'
+
+module Generics
+  # Your code goes here...
+end
+
+require 'generics/collections/list'

data/lib/generics/collections/list.rb

@@ -0,0 +1,226 @@
+require 'hamster'
+
+module Generics
+  class List
+    include Enumerable
+
+    # Shared
+
+    class NotSameType < StandardError
+    end
+
+    # @param [Class, Module] type
+    # @return [Class]
+    def self.[](type)
+      Class.new(self).tap do |klass|
+        klass.instance_variable_set('@type', type)
+        klass.define_singleton_method(:name) { klass.superclass.name }
+      end
+    end
+
+    def self.type
+      @type
+    end
+
+    def compatible?(value)
+      value.is_a?(self.class.type)
+    end
+
+    def compatible!(value)
+      fail NotSameType unless value.is_a?(self.class.type)
+      true
+    end
+
+    # Object
+
+    def inspect
+      "#<#{self.class.name}[#{self.class.type}]: #{to_s}>"
+    end
+
+    def to_s
+      @collection.to_a.to_s
+    end
+
+    # Enumerable
+
+    def [](index)
+      @collection[index]
+    end
+
+    def each
+      @collection.each { |item| yield item }
+      return self
+    end
+
+    def map
+      self.class.new(super)
+    end
+
+    # Array
+
+    # Getters
+
+    def size
+      @collection.size
+    end
+
+    def length
+      @collection.length
+    end
+
+    def empty?
+      @collection.empty?
+    end
+
+    def last
+      @collection.last
+    end
+
+    def pop
+      @collection.pop
+    end
+
+    def reverse
+      @collection.reverse
+    end
+
+    def sample
+      @collection.sample
+    end
+
+    def slice(*args)
+      @collection.slice(*args)
+    end
+
+    # Methods that returns self
+
+    def delete_at(index)
+      self.class.new(*@collection.delete_at(index))
+    end
+
+    def shift
+      self.class.new(*@collection.shift)
+    end
+
+    def uniq(&block)
+      self.class.new(*@collection.uniq(&block))
+    end
+
+    # Immutable (default) only
+
+    # @param [Class, Module] type
+    def initialize(*collection)
+      collection.each { |value| compatible!(value) }
+      @collection = ::Hamster::Vector.new(collection)
+    end
+
+    # Does not preserve frozen state and does not copy singleton state
+    # @return [List]
+    def dup
+      self.class.new(*@collection.dup)
+    end
+
+    # Preserves frozen state and does copies singleton state
+    # @return [List]
+    def clone
+      self.class.new(*@collection.clone)
+    end
+
+    # Quick dup; does not duplicate, just relies on immutability
+    # @return [List]
+    def qdup
+      self.class.new(*@collection)
+    end
+
+    # Destructive
+
+    def add(value)
+      compatible!(value)
+      self.class.new(*@collection.add(value))
+    end
+
+    def set(index, value, &block)
+      compatible!(value)
+      self.class.new(*@collection.set(index, value, &block))
+    end
+
+    def insert(index, *values)
+      values.each { |value| compatible!(value) }
+      self.class.new(*@collection.insert(index, *values))
+    end
+
+    def delete(value)
+      compatible!(value)
+      self.class.new(*@collection.delete(value))
+    end
+
+    def delete_at(index)
+      self.class.new(*@collection.delete_at(index))
+    end
+
+    def unshift(value)
+      compatible!(value)
+      self.class.new(*@collection.unshift(value))
+    end
+
+    class Mutable < List
+      # @param [Class, Module] type
+      def initialize(*collection)
+        collection.each { |value| compatible!(value) }
+        @collection = collection.freeze
+      end
+
+      # Does not preserve frozen state and does not copy singleton state
+      # @return [List::Mutable]
+      def dup
+        self.class.new(*@collection.dup)
+      end
+
+      # Preserves frozen state and does copies singleton state
+      # @return [List::Mutable]
+      def clone
+        self.class.new(*@collection.clone)
+      end
+
+      # Destructive
+
+      def add(value)
+        compatible!(value)
+        @collection.push(value)
+      end
+
+      def set(index, value, &_block)
+        compatible!(value)
+        if block_given?
+          @collection[index] = yield @collection[index]
+        else
+          @collection[index] = value
+        end
+      end
+
+      def []=(index, value)
+        compatible!(value)
+        @collection[index] = value
+      end
+
+      def insert(index, *values)
+        values.each { |value| compatible!(value) }
+        self.class.new(*@collection.insert(index, *values))
+      end
+
+      def delete(value)
+        compatible!(value)
+        @collection.delete(value)
+      end
+
+      def delete_at(index)
+        @collection.delete_at(index)
+      end
+
+      def unshift(value)
+        compatible!(value)
+        self.class.new(*@collection.unshift(value))
+      end
+    end
+  end
+end

data/lib/generics/version.rb

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

metadata

@@ -0,0 +1,255 @@
+--- !ruby/object:Gem::Specification
+name: generics
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- matrinox
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+- !ruby/object:Gem::Dependency
+  name: pry-coolline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.5
+- !ruby/object:Gem::Dependency
+  name: pry-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.4
+- !ruby/object:Gem::Dependency
+  name: pry-toys
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+- !ruby/object:Gem::Dependency
+  name: pry-macro
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: pry-state
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.7
+- !ruby/object:Gem::Dependency
+  name: pry-inline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: pry-doc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: pry-highlight
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: hamster
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: Generics for Ruby, starting with collections
+email:
+- geoff.lee@lendesk.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- generics.gemspec
+- lib/generics.rb
+- lib/generics/collections/list.rb
+- lib/generics/version.rb
+homepage: https://github.com/matrinox/generics
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Generics for Ruby
+test_files: []
+has_rdoc: