fried-typings 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 86853d9a07622e785db2dabbc2071db3715e0ff0
+  data.tar.gz: 63e0a1de55ef8e02517fc0fd886f3da14a9cf75c
+SHA512:
+  metadata.gz: a6ebdffc3ddb599eb4830eae30de020cfae619ecfb8b20f0949702f6f6477a9bee0e63946b3b8b6b7b7a1bf2567514c06753906a4f5a88b2825f7c87bfc69ad3
+  data.tar.gz: 0a2cb1311a314d58bb3e9f9ea6eb1bd6f0ac3a47a9239d0c11fa6a376c5e2a9528d0b7d09391790dffc11ac4f5870d92fcb9368a6ed74a5674b562e048544457

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+Gemfile.lock
+.envrc
+/binstubs/

data/.travis.yml

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

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 fried-typings.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Francesco Belladonna
+
+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,130 @@
+# Fried::Typings [![Build Status][test-badge]][test-link]
+
+Composable type-safety checks.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "fried-typings"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fried-typings
+
+## Usage
+
+Let's say you have a class `Hello` which accepts a name as argument, and you
+want to ensure it's a `String`:
+
+```ruby
+require "fried/typings"
+
+class Hello
+  include Fried::Typings
+
+  def call(name)
+    Is[String].(name)
+
+    "Hello, #{name}"
+  end
+end
+
+hello = Hello.new
+
+hello.("Francesco") # => "Hello, Francesco"
+hello.(123) # => raises TypeError
+```
+
+You can nest checks too:
+
+```ruby
+one_of = OneOf[Numeric, IsStrictly[StandardError]]
+
+one_of.(123) # => 123
+one_of.(StandardError.new) # => #<StandardError: StandardError>
+one_of.(ArgumentError.new) # => raises TypeError
+```
+
+And if you don't want to raise error, just use `#valid?`
+
+```ruby
+one_of = OneOf[Numeric, IsStrictly[StandardError]]
+
+one_of.valid?(123) # => true
+one_of.(ArgumentError.new) # => false
+```
+
+### Available types
+
+- `Is[type]` checks that object `is_a?(type)`
+- `IsStrictly[type]` check that `object.class == type`
+- `OneOf[type1, type2, ...typeN]` checks that object pass `Is[typeN]` for
+  **any** of the types
+- `StrictlyOneOf[type1, type2, ...typeN]` checks that object pass
+  `IsStrictly[typeN]` for **any** of the types
+- `Boolean` checks that object is either `true` or `false`
+- `ArrayOf[type]` checks that all element of the array pass `Is[type]`
+- `HashOf[key_type, value_type]` checks that all pairs of hash pass
+  `Is[key_type]` and `Is[value_type]`
+- `EnumeratorOf[type]` checks that all element of the enumerator pass
+  `Is[type]`
+- `TupleOf[type1, type2, ...typeN]` checks that each object of the array
+  passes `Is[typeN]` the type at the same index in `[]`. If array size differ
+  from the amount of specified types, it doesn't pass. E.g.:
+  `TupleOf[String, Numeric].valid?(["test", 123]) # => true`. While
+  `TupleOf[String, Numeric].valid?([nil, 123]) # => false`. Finally,
+  `TupleOf[String].valid?(["test", 123]) # => false` because array size don't
+  match
+
+### Custom types
+
+You can build easily your custom types:
+
+```ruby
+class Is
+  include MetaType
+  include Type
+
+  def initialize(type)
+    @type = type
+  end
+
+  def valid?(obj)
+    # If it's one of the `Type` from Fried::Typings, check with those, to
+    # allow chaining/nesting
+    return type.valid?(obj) if @type < Type
+
+    # Otherwise perform the check how we would do
+    obj.is_a?(@type)
+  end
+end
+```
+
+This will allow the following usage:
+
+And yes this is _exactly_ how `Is` is implemented. However, it deserves some
+explaination.
+
+`Type` does all the heavy lifting. You would need only that. `MetaType` adds
+a class method `[]` that delegates directly to `new`.
+You don't need `MetaType`, it's just there to improve syntax.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake` 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/Fire-Dragon-DoL/fried-typings.
+
+[test-badge]: https://travis-ci.org/Fire-Dragon-DoL/fried-typings.svg?branch=master
+[test-link]: https://travis-ci.org/Fire-Dragon-DoL/fried-typings

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "fried/test/rake"
+
+include Fried::Test::Rake
+
+task default: :test

data/bin/console

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

@@ -0,0 +1,35 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "fried/typings/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "fried-typings"
+  spec.version       = Fried::Typings::VERSION
+  spec.authors       = ["Fire-Dragon-DoL"]
+  spec.email         = ["francesco.belladonna@gmail.com"]
+  spec.licenses      = ["MIT"]
+
+  spec.summary       = %q{Composable type-safety checks}
+  spec.description   = %q{Composable type-safety checks}
+  spec.homepage      = "https://github.com/Fire-Dragon-DoL/fried-typings"
+  spec.metadata      = {
+    "source_code_uri" => "https://github.com/Fire-Dragon-DoL/fried-typings"
+  }
+
+  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"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "minitest-focus"
+  spec.add_development_dependency "minitest-reporters"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "fried-test"
+
+  spec.add_runtime_dependency "fried-core"
+end

data/lib/fried/typings.rb

@@ -0,0 +1,17 @@
+require "fried/typings/version"
+require "fried/typings/array_of"
+require "fried/typings/boolean"
+require "fried/typings/enumerator_of"
+require "fried/typings/hash_of"
+require "fried/typings/is"
+require "fried/typings/is_strictly"
+require "fried/typings/meta_type"
+require "fried/typings/one_of"
+require "fried/typings/strictly_one_of"
+require "fried/typings/tuple_of"
+require "fried/typings/type"
+
+module Fried
+  module Typings
+  end
+end

data/lib/fried/typings/array_of.rb

@@ -0,0 +1,32 @@
+require "fried/core"
+require "fried/typings/is"
+require "fried/typings/enumerator_of"
+require "fried/typings/meta_type"
+require "fried/typings/type"
+
+module Fried::Typings
+  # Checks if all elements of the array match given type
+  class ArrayOf
+    include MetaType
+    include Type
+
+    private
+
+    attr_reader :type
+
+    public
+
+    def initialize(type)
+      @type = type
+    end
+
+    # @param ary [Array]
+    def valid?(ary)
+      return false unless Is[Array].valid?(ary)
+
+      enumerator = ary.each
+
+      EnumeratorOf[type].valid?(enumerator)
+    end
+  end
+end

data/lib/fried/typings/boolean.rb

@@ -0,0 +1,7 @@
+require "fried/core"
+require "fried/typings/one_of"
+
+module Fried::Typings
+  # Checks if the object is {TrueClass} or {FalseClass}
+  Boolean = OneOf[TrueClass, FalseClass]
+end

data/lib/fried/typings/enumerator_of.rb

@@ -0,0 +1,30 @@
+require "fried/core"
+require "fried/typings/type"
+require "fried/typings/meta_type"
+require "fried/typings/is"
+
+module Fried::Typings
+  # Checks if all enumerated objects {Is} of passed type
+  class EnumeratorOf
+    include MetaType
+    include Type
+
+    private
+
+    attr_reader :type
+
+    public
+
+    def initialize(type)
+      @type = type
+    end
+
+    # Notice that the method will actually iterate over the enumerator
+    # @param enumerator [Enumerator]
+    def valid?(enumerator)
+      return false unless Is[Enumerator].valid?(enumerator)
+
+      enumerator.all? { |obj| Is[type].valid?(obj) }
+    end
+  end
+end

data/lib/fried/typings/hash_of.rb

@@ -0,0 +1,35 @@
+require "fried/core"
+require "fried/typings/enumerator_of"
+require "fried/typings/is"
+require "fried/typings/meta_type"
+require "fried/typings/tuple_of"
+require "fried/typings/type"
+
+module Fried::Typings
+  # Checks if all key => value elements of the hashmap match the types pair
+  class HashOf
+    include MetaType
+    include Type
+
+    private
+
+    attr_reader :key_type
+    attr_reader :value_type
+
+    public
+
+    def initialize(key_type, value_type)
+      @key_type = key_type
+      @value_type = value_type
+    end
+
+    # @param hsh [Hash]
+    def valid?(hsh)
+      return false unless Is[Hash].valid?(hsh)
+
+      enumerator = hsh.each
+
+      EnumeratorOf[TupleOf[key_type, value_type]].valid?(enumerator)
+    end
+  end
+end

data/lib/fried/typings/is.rb

@@ -0,0 +1,27 @@
+require "fried/core"
+require "fried/typings/meta_type"
+require "fried/typings/type"
+
+module Fried::Typings
+  # Checks if the object {#is_a?} object of the passed type
+  class Is
+    include MetaType
+    include Type
+
+    private
+
+    attr_reader :type
+
+    public
+
+    def initialize(type)
+      @type = type
+    end
+
+    def valid?(obj)
+      return type.valid?(obj) if type < Type
+
+      obj.is_a?(type)
+    end
+  end
+end

data/lib/fried/typings/is_strictly.rb

@@ -0,0 +1,27 @@
+require "fried/core"
+require "fried/typings/meta_type"
+require "fried/typings/type"
+
+module Fried::Typings
+  # Checks if the object.class is exactly of the passed type
+  class IsStrictly
+    include MetaType
+    include Type
+
+    private
+
+    attr_reader :type
+
+    public
+
+    def initialize(type)
+      @type = type
+    end
+
+    def valid?(obj)
+      return type.valid?(obj) if type < Type
+
+      obj.class == type
+    end
+  end
+end

data/lib/fried/typings/meta_type.rb

@@ -0,0 +1,28 @@
+require "forwardable"
+require "fried/core"
+
+module Fried::Typings
+  # Protocol to generate {Type}
+  module MetaType
+    MissingTypeError = Class.new(StandardError)
+
+    def self.included(klass)
+      klass.instance_eval do
+        class << self
+          extend Forwardable
+
+          # @!method []
+            # @param args [Array<Class, Module, Type>]
+            # @return [Type]
+          def_delegator :self, :new, :[]
+        end
+      end
+    end
+
+    protected
+
+    def missing_type!
+      raise MissingTypeError, "No type(s) configured for the meta type"
+    end
+  end
+end

data/lib/fried/typings/one_of.rb

@@ -0,0 +1,29 @@
+require "fried/core"
+require "fried/typings/type"
+require "fried/typings/meta_type"
+require "fried/typings/is"
+
+module Fried::Typings
+  # Checks if the object {#is_a?} object of the passed types
+  class OneOf
+    include MetaType
+    include Type
+
+    private
+
+    attr_reader :types
+
+    public
+
+    def initialize(*types)
+      @types = types
+      missing_type! if types.empty?
+    end
+
+    def valid?(obj)
+      types.any? do |type|
+        Is[type].valid?(obj)
+      end
+    end
+  end
+end

data/lib/fried/typings/strictly_one_of.rb

@@ -0,0 +1,29 @@
+require "fried/core"
+require "fried/typings/type"
+require "fried/typings/meta_type"
+require "fried/typings/is_strictly"
+
+module Fried::Typings
+  # Checks if the object.class is exactly one of the passed types
+  class StrictlyOneOf
+    include MetaType
+    include Type
+
+    private
+
+    attr_reader :types
+
+    public
+
+    def initialize(*types)
+      @types = types
+      missing_type! if types.empty?
+    end
+
+    def valid?(obj)
+      types.any? do |type|
+        IsStrictly[type].valid?(obj)
+      end
+    end
+  end
+end

data/lib/fried/typings/tuple_of.rb

@@ -0,0 +1,31 @@
+require "fried/core"
+require "fried/typings/type"
+require "fried/typings/meta_type"
+require "fried/typings/is"
+
+module Fried::Typings
+  # Checks if Array fields match types specified on a 1-to-1 relationship.
+  # So `[123, "test", nil]` matches `TupleOf[Numeric, String, NilClass]`
+  class TupleOf
+    include MetaType
+    include Type
+
+    private
+
+    attr_reader :types
+
+    public
+
+    def initialize(*types)
+      @types = types
+    end
+
+    def valid?(ary)
+      return false unless ary.size == types.size
+
+      types.each.with_index.all? do |type, index|
+        Is[type].valid?(ary[index])
+      end
+    end
+  end
+end

data/lib/fried/typings/type.rb

@@ -0,0 +1,39 @@
+require "forwardable"
+require "fried/core"
+
+module Fried::Typings
+  # Protocol to validate object type
+  module Type
+    def self.included(klass)
+      klass.instance_eval do
+        include Comparable
+      end
+    end
+
+    # Compares own class with other object (which should be a class)
+    # @param other [Class,Module]
+    def <=>(other)
+      self.class <=> other
+    end
+
+    # @param obj any object
+    # @return the passed object
+    # @raise [TypeError] should be raised if {#valid?} is false
+    def call(obj)
+      invalid_type!(obj) unless valid?(obj)
+      obj
+    end
+
+    # @param obj any object
+    # @return [Boolean] true if object is of valid type
+    def valid?(obj)
+      raise NotImplementedError
+    end
+
+    protected
+
+    def invalid_type!(obj)
+      raise TypeError, "Type of `obj` is #{obj.class} - #{obj.inspect}"
+    end
+  end
+end

data/lib/fried/typings/version.rb

@@ -0,0 +1,5 @@
+module Fried
+  module Typings
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,179 @@
+--- !ruby/object:Gem::Specification
+name: fried-typings
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Fire-Dragon-DoL
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-11-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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
+  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'
+- !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: pry-byebug
+  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: 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'
+- !ruby/object:Gem::Dependency
+  name: fried-test
+  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: fried-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Composable type-safety checks
+email:
+- francesco.belladonna@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- fried-typings.gemspec
+- lib/fried/typings.rb
+- lib/fried/typings/array_of.rb
+- lib/fried/typings/boolean.rb
+- lib/fried/typings/enumerator_of.rb
+- lib/fried/typings/hash_of.rb
+- lib/fried/typings/is.rb
+- lib/fried/typings/is_strictly.rb
+- lib/fried/typings/meta_type.rb
+- lib/fried/typings/one_of.rb
+- lib/fried/typings/strictly_one_of.rb
+- lib/fried/typings/tuple_of.rb
+- lib/fried/typings/type.rb
+- lib/fried/typings/version.rb
+homepage: https://github.com/Fire-Dragon-DoL/fried-typings
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/Fire-Dragon-DoL/fried-typings
+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.14
+signing_key: 
+specification_version: 4
+summary: Composable type-safety checks
+test_files: []