typical 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d39962302fd2b80a007d4c6212e8251144e7817f
+  data.tar.gz: 595b2bc1838b0b136f4e34b4cd99eb912727e5b5
+SHA512:
+  metadata.gz: 146cd162336ae7042a4d32019cdbaf7c616f4daf2f8d80989cd271f9d17fecdbe64a34633ee1e038d3ede8f55fe3ea25594a386191c01f5c8d92b4af766bebb5
+  data.tar.gz: 1db4dc5f3078c55e609a67591831e81f3397bd6fa62e8d5141cab24dc05d4c3e69e787370e4191c678cac006be371f48d3cadccf8af15ee5018ccc3f9de4dd69

data/.gitignore

@@ -0,0 +1,7 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/tmp/

data/.travis.yml

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

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,41 @@
+PATH
+  remote: .
+  specs:
+    typical (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ansi (1.5.0)
+    builder (3.2.3)
+    minitest (5.10.2)
+    minitest-around (0.4.0)
+      minitest (~> 5.0)
+    minitest-focus (1.1.2)
+      minitest (>= 4, < 6)
+    minitest-reporters (1.1.14)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    minitest-sprint (1.2.0)
+      path_expander (~> 1.0)
+    path_expander (1.0.2)
+    rake (10.5.0)
+    ruby-progressbar (1.8.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.14)
+  minitest (~> 5.0)
+  minitest-around (~> 0.4)
+  minitest-focus
+  minitest-reporters
+  minitest-sprint
+  rake (~> 10.0)
+  typical!
+
+BUNDLED WITH
+   1.14.6

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Eloy Durán <eloy.de.enige@gmail.com>
+
+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,106 @@
+# Typical
+
+This library provides a DSL to describe the types of your data and ways to validate them.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "typical"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install typical
+
+## Usage
+
+### DSL
+
+To specify type information, you can use the `Typical::DSL` module.
+
+```ruby
+require "typical/dsl"
+include Typical::DSL
+```
+
+The bang methods are used to define types.
+
+```ruby
+String!                    # => #<Type:String>
+```
+
+You can allow multiple types by creating a union of them.
+
+```ruby
+String! | Integer!         # => #<Type:Union [#<Type:String>, #<Type:Integer>]>
+```
+
+Sometimes a field can also be null.
+
+```ruby
+String! | Integer! | null  # => #<Type:Union [#<Type:String>, , #<Type:Integer>, #<Type:NilClass>]>
+```
+
+If you’re defining a single type, but nullable, use the question mark methods instead.
+
+```ruby
+String?                    # => #<Type:Union [#<Type:String>, #<Type:NilClass>]>
+```
+
+You can have collections too, you use them like you normally would.
+
+```ruby
+Set!(String!, Integer!)    # => #<Type:Set [#<Type:Union [#<Type:String>, #<Type:Integer>]>]>
+Array!(String!, Integer!)  # => #<Type:Array [#<Type:Union [#<Type:String>, #<Type:Integer>]>]>
+Hash!(String! => Integer!) # => #<Type:Hash { [#<Type:Union [#<Type:String>]>] => [#<Type:Union [#<Type:Integer>]>] }>
+```
+
+### Validation
+
+_NOTE: This is not yet implemented._
+
+```ruby
+typing = Array!(String!)
+typing.valid?("string")    # => false
+typing.valid?([nil])       # => false
+typing.valid?([])          # => true
+typing.valid?(["string"])  # => true
+```
+
+### Mongoid
+
+_NOTE: This is not yet implemented._
+
+This Mongoid integration allows you to both reflect on the data types in your database and validate incoming data.
+
+```ruby
+class Artist
+  include Mongoid::Document
+  include Typical::Mongoid
+
+  field :name, type: String?
+  field :image_versions, type: Array!(Symbol!)
+  field :image_urls, type: Hash!(String! => String!)
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/alloy/typical.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](LICENSE.txt).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:spec) do |t|
+  t.libs << "spec"
+  t.libs << "lib"
+  t.test_files = FileList["spec/**/*_spec.rb"]
+end
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "typical"
+
+# 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/typical/dsl.rb

@@ -0,0 +1,63 @@
+require "typical/type"
+
+module Typical
+  module DSL
+    def self.define_scalar_type(mod, name = nil)
+      name ||= mod.name
+      define_method("#{name}!") { Type.new(mod) }
+      define_method("#{name}?") { Type.new(mod) | null }
+    end
+
+    BUILTIN_SCALAR_TYPES = [
+      Integer,
+      Float,
+      Object,
+      Range,
+      Regexp,
+      String,
+      Symbol,
+      Time,
+    ].freeze
+
+    BUILTIN_SCALAR_TYPES.each do |klass|
+      define_scalar_type(klass)
+    end
+
+    def null
+      Type.new(NilClass)
+    end
+
+    def Hash!(types = {})
+      Type::Hash.new(types)
+    end
+
+    def Hash?(types = {})
+      Hash!(types) | null
+    end
+
+    def Set!(*types)
+      Type::Set.new(*types)
+    end
+
+    # TODO: It actually appears that mongo/mongoid does not return `null` for set fields.
+    def Set?(*types)
+      Set!(*types) | null
+    end
+
+    def Array!(*types)
+      Type::Array.new(types)
+    end
+
+    def Array?(*types)
+      Array!(*types) | null
+    end
+
+    def Reference!(reference)
+      Type::Reference.new(reference)
+    end
+
+    def Reference?(reference)
+      Reference!(reference) | null
+    end
+  end
+end

data/lib/typical/type/list.rb

@@ -0,0 +1,123 @@
+require "typical/type"
+require "typical/type/union"
+
+module Typical
+  class Type
+    class List < Type
+      attr_reader :storage
+
+      def initialize(*objects)
+        @storage = new_storage
+        load_from_objects(objects)
+      end
+
+      def normalize
+        self.class.new.tap { |copy| copy.values = values.normalize(false) }
+      end
+
+      def values
+        @storage[:values]
+      end
+
+      def values=(values)
+        @storage[:values] = values
+      end
+
+      def empty?
+        values.empty?
+      end
+
+      def ==(other)
+        other.is_a?(self.class) && values == other.values
+      end
+
+      def eql?(other)
+        super && @storage == other.storage
+      end
+
+      def hash
+        [super, @storage].hash
+      end
+
+      def inspect
+        "#<Type:#{type} [#{values.inspect}]>"
+      end
+
+
+      private
+
+      def new_storage
+        { values: Union.new }
+      end
+
+      def load_from_objects(objects)
+        objects.each do |object|
+          if object.is_a?(type)
+            load_from_list_object(object)
+          else
+            load_from_object(object)
+          end
+        end
+      end
+
+      def load_from_list_object(list)
+        list.each { |object| load_from_object(object) }
+      end
+
+      def load_from_object(object, storage_key = :values)
+        @storage[storage_key].types << Type.of(object)
+      end
+    end
+
+    class Array < List
+      def type
+        ::Array
+      end
+    end
+
+    class Set < List
+      def type
+        ::Set
+      end
+    end
+
+    class Hash < List
+      def type
+        ::Hash
+      end
+
+      def normalize
+        super.tap { |copy| copy.keys = keys.normalize(false) }
+      end
+
+      def keys
+        @storage[:keys]
+      end
+
+      def keys=(keys)
+        @storage[:keys] = keys
+      end
+
+      def inspect
+        "#<Type:#{type} { [#{keys.inspect}] => [#{values.inspect}] }>"
+      end
+
+      def ==(other)
+        super && keys == other.keys
+      end
+
+      private
+
+      def new_storage
+        super.merge(keys: Union.new)
+      end
+
+      def load_from_list_object(hash)
+        hash.each do |key, value|
+          load_from_object(key, :keys)
+          load_from_object(value, :values)
+        end
+      end
+    end
+  end
+end

data/lib/typical/type/reference.rb

@@ -0,0 +1,11 @@
+require "typical/type"
+
+module Typical
+  class Type
+    class Reference < Type
+      def inspect
+        "#<Type:Reference(#{type})>"
+      end
+    end
+  end
+end

data/lib/typical/type/union.rb

@@ -0,0 +1,74 @@
+require "typical/type"
+
+module Typical
+  class Type
+    class Union < Type
+      attr_reader :types
+
+      def initialize(types = [])
+        raise TypeError, "Requires an array of types" unless types.is_a?(::Array)
+        @types = ::Set.new(types.map { |type| Type.of(type) })
+      end
+
+      def prominent_type
+        copy = types.dup
+        copy.delete_if { |type| type.type == NilClass }
+        copy.first if copy.size == 1
+      end
+
+      def empty?
+        @types.empty?
+      end
+
+      def ==(other)
+        other.is_a?(Union) && @types == other.types
+      end
+
+      def hash
+        @types.hash
+      end
+
+      def |(other)
+        raise TypeError, "Can only make a union of Type and subclasses of Type" unless other.is_a?(Type)
+        Union.new((types + other.types).to_a)
+      end
+
+      def normalize(unwrap_single_type = true)
+        normalized = Union.new
+        types = self.types.dup
+
+        arrays = types.select { |type| type.type == ::Array }
+        unless arrays.empty?
+          types -= arrays
+          normalized |= Array.new(arrays.map(&:values).reduce(:|).types.to_a).normalize
+        end
+
+        sets = types.select { |type| type.type == ::Set }
+        unless sets.empty?
+          types -= sets
+          normalized |= Set.new(::Set.new(sets.map(&:values).reduce(:|).types.to_a)).normalize
+        end
+
+        hashes = types.select { |type| type.type == ::Hash }
+        unless hashes.empty?
+          types -= hashes
+          hash = Hash.new
+          hash.keys |= hashes.map(&:keys).reduce(:|)
+          hash.values |= hashes.map(&:values).reduce(:|)
+          normalized |= hash.normalize
+        end
+
+        # Add remainder
+        types.each { |type| normalized |= type.normalize }
+        # If there’s only 1 type, unwrap it from the union type.
+        normalized = normalized.types.first if unwrap_single_type && normalized.types.size == 1
+
+        normalized
+      end
+
+      def inspect
+        "#<Type:Union [#{@types.map(&:inspect).join(", ")}]>"
+      end
+    end
+  end
+end

data/lib/typical/type.rb

@@ -0,0 +1,76 @@
+module Typical
+  class Type
+    def self.of(object)
+      case object
+      when Type
+        object
+      when ::Hash
+        Hash.new(object)
+      when ::Array
+        Array.new(object)
+      when ::Set
+        Set.new(object)
+      when Class
+        if object == ::Hash
+          Hash.new
+        elsif object == ::Array
+          Array.new
+        elsif object == ::Set
+          Set.new
+        else
+          new(object)
+        end
+      else
+        new(object.class)
+      end
+    end
+
+    attr_reader :type
+
+    def initialize(type)
+      @type = type
+    end
+
+    # This makes Type and Type::Union duck-typable
+    def types
+      ::Set.new([self])
+    end
+
+    def ==(other)
+      other.is_a?(Type) && type == other.type
+    end
+
+    def eql?(other)
+      self == other
+    end
+
+    def hash
+      type.hash
+    end
+
+    def |(other)
+      raise TypeError, "Can only make a union of Type and subclasses of Type" unless other.is_a?(Type)
+      other.is_a?(Union) ? (other | self) : Union.new([self, other])
+    end
+
+    def nullable?
+      types.any? { |type| type.type == NilClass }
+    end
+
+    def normalize
+      self
+    end
+
+    def prominent_type
+      self
+    end
+
+    def inspect
+      "#<Type:#{type}>"
+    end
+  end
+end
+
+require "typical/type/list"
+require "typical/type/reference"
+require "typical/type/union"

data/lib/typical/version.rb

@@ -0,0 +1,3 @@
+module Typical
+  VERSION = "0.1.0"
+end

data/lib/typical.rb

@@ -0,0 +1,5 @@
+require "typical/type"
+require "typical/version"
+
+module Typical
+end

data/typical.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'typical/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "typical"
+  spec.version       = Typical::VERSION
+  spec.authors       = ["Eloy Durán"]
+  spec.email         = ["eloy.de.enige@gmail.com"]
+
+  spec.summary       = "A Ruby library to describe the types of your data and ways to validate them."
+  spec.homepage      = "https://github.com/alloy/typical"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "minitest-around", "~> 0.4"
+  spec.add_development_dependency "minitest-reporters"
+  spec.add_development_dependency "minitest-sprint"
+  spec.add_development_dependency "minitest-focus"
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: typical
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Eloy Durán
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-07-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-around
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  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'
+- !ruby/object:Gem::Dependency
+  name: minitest-sprint
+  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'
+- !ruby/object:Gem::Dependency
+  name: minitest-focus
+  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: 
+email:
+- eloy.de.enige@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/typical.rb
+- lib/typical/dsl.rb
+- lib/typical/type.rb
+- lib/typical/type/list.rb
+- lib/typical/type/reference.rb
+- lib/typical/type/union.rb
+- lib/typical/version.rb
+- typical.gemspec
+homepage: https://github.com/alloy/typical
+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.6.11
+signing_key: 
+specification_version: 4
+summary: A Ruby library to describe the types of your data and ways to validate them.
+test_files: []