kinda 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: c8b670daf90f084b58d09319a0646f95cee3bf4e
4
+ data.tar.gz: 99213d89f34553f8dad0dea155c794f878161a71
5
+ SHA512:
6
+ metadata.gz: 6100a627b619fc905a2a4b0a9fcf318f59d219e7f6c16d1464c45a79fad1422b08e101f175fa415e38a043006244a5c30cd11ff6f108845ce2135f9a653fa179
7
+ data.tar.gz: 61b2a5c37dbecc2a2497d742a0fb5a77502acd3c09ab7524650b939074a0797389eaee664b1d78e62a7836a814a4d1ab53f082aa2c8112c3fde2feece53e5765
data/.gitignore ADDED
@@ -0,0 +1,9 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --format documentation
2
+ --color
data/.travis.yml ADDED
@@ -0,0 +1,4 @@
1
+ language: ruby
2
+ rvm:
3
+ - 2.3.0
4
+ before_install: gem install bundler -v 1.11.2
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in kinda.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2017 Samuel Scully
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,67 @@
1
+ # Kinda
2
+
3
+ Super basic type checking functions in ruby.
4
+
5
+ ## Usage
6
+
7
+ ```
8
+ module Type
9
+ include Kinda.module
10
+ end
11
+
12
+ Type[Float].call(1.0)
13
+ # => 1.0
14
+
15
+ Type[Float].call(1)
16
+ # => Kinda::ConstraintError: expected Float but given Fixnum
17
+ ```
18
+
19
+ In addition to any normal Ruby class the following custom types are available.
20
+
21
+ * Nil
22
+ * True
23
+ * False
24
+ * Bool
25
+
26
+ ```
27
+ Type[Bool].call(true)
28
+ # => true
29
+
30
+ Type[Bool].call(false)
31
+ # => false
32
+
33
+ Type[Bool].call(nil)
34
+ # => Kinda::ConstraintError: expected [TrueClass, FalseClass] but given NilClass
35
+ ```
36
+
37
+ New types can also be defined in terms of existing types.
38
+
39
+ ```
40
+ require 'bigdecimal'
41
+
42
+ Decimal = [BigDecimal, Float]
43
+
44
+ Type[Decimal].call(BigDecimal.new('1.0'))
45
+ # => #<BigDecimal:7fdd2c3aa9b0,'0.1E1',9(18)>
46
+
47
+ MaybeDecimal = [Nil, Decimal]
48
+
49
+ Type[MaybeDecimal].call(1.0)
50
+ # => 1.0
51
+
52
+ Type[MaybeDecimal].call(nil)
53
+ # => nil
54
+
55
+ Type[MaybeDecimal].call(1)
56
+ # => Kinda::ConstraintError: expected [NilClass, BigDecimal, Float] but given Fixnum
57
+ ```
58
+
59
+ ## Contributing
60
+
61
+ Bug reports and pull requests are welcome on GitHub at https://github.com/sbscully/kinda.
62
+
63
+
64
+ ## License
65
+
66
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
67
+
data/Rakefile ADDED
@@ -0,0 +1,6 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task :default => :spec
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "kinda"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start
data/bin/setup ADDED
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
data/kinda.gemspec ADDED
@@ -0,0 +1,24 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'kinda/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "kinda"
8
+ spec.version = Kinda::VERSION
9
+ spec.authors = ["Samuel Scully"]
10
+ spec.email = ["sbscully@gmail.com"]
11
+
12
+ spec.summary = %q{Super basic type checking functions in ruby.}
13
+ spec.homepage = "https://github.com/sbscully/kinda"
14
+ spec.license = "MIT"
15
+
16
+ spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
17
+ spec.bindir = "exe"
18
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
19
+ spec.require_paths = ["lib"]
20
+
21
+ spec.add_development_dependency "bundler", "~> 1.11"
22
+ spec.add_development_dependency "rake", "~> 10.0"
23
+ spec.add_development_dependency "rspec", "~> 3.0"
24
+ end
data/lib/kinda.rb ADDED
@@ -0,0 +1,68 @@
1
+ require "kinda/version"
2
+
3
+ class Kinda < Module
4
+ ConstraintError = Class.new(ArgumentError)
5
+
6
+ class << self
7
+ def module
8
+ new
9
+ end
10
+ end
11
+
12
+ def initialize
13
+ Object.include(Kinda::Types)
14
+ end
15
+
16
+ def included(host)
17
+ host.extend(ClassMethods)
18
+ end
19
+
20
+ module ClassMethods
21
+ def [](*klasses)
22
+ klasses = klasses.flatten.map { |k| convert_custom_klass(k) }.flatten
23
+
24
+ unless klasses.all? { |k| k.kind_of?(Class) }
25
+ raise ArgumentError.new("expected Class but given #{klasses.map(&:class).inspect}")
26
+ end
27
+
28
+ lambda do |obj|
29
+ if klasses.none? { |k| obj.kind_of?(k) }
30
+ raise ConstraintError.new("expected #{klasses.inspect} but given #{obj.class}")
31
+ end
32
+
33
+ obj
34
+ end
35
+ end
36
+
37
+ private
38
+
39
+ def convert_custom_klass(klass)
40
+ return klass unless klass < Kinda::Types::Custom
41
+
42
+ case klass.name
43
+ when 'Kinda::Types::Nil'
44
+ NilClass
45
+ when 'Kinda::Types::True'
46
+ TrueClass
47
+ when 'Kinda::Types::False'
48
+ FalseClass
49
+ when 'Kinda::Types::Bool'
50
+ [TrueClass, FalseClass]
51
+ else
52
+ klass
53
+ end
54
+ end
55
+ end
56
+ private_constant(:ClassMethods)
57
+
58
+ module Types
59
+ Custom = Class.new
60
+
61
+ PREFIX = "__KINDA__"
62
+ Nil = Class.new(Custom) unless defined?(Object::Nil)
63
+ True = Class.new(Custom) unless defined?(Object::True)
64
+ False = Class.new(Custom) unless defined?(Object::False)
65
+ Bool = Class.new(Custom) unless defined?(Object::Bool)
66
+ end
67
+
68
+ end
@@ -0,0 +1,3 @@
1
+ class Kinda < Module
2
+ VERSION = "0.1.0"
3
+ end
metadata ADDED
@@ -0,0 +1,98 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: kinda
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Samuel Scully
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2017-01-18 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.11'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.11'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '10.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '10.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rspec
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '3.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '3.0'
55
+ description:
56
+ email:
57
+ - sbscully@gmail.com
58
+ executables: []
59
+ extensions: []
60
+ extra_rdoc_files: []
61
+ files:
62
+ - ".gitignore"
63
+ - ".rspec"
64
+ - ".travis.yml"
65
+ - Gemfile
66
+ - LICENSE.txt
67
+ - README.md
68
+ - Rakefile
69
+ - bin/console
70
+ - bin/setup
71
+ - kinda.gemspec
72
+ - lib/kinda.rb
73
+ - lib/kinda/version.rb
74
+ homepage: https://github.com/sbscully/kinda
75
+ licenses:
76
+ - MIT
77
+ metadata: {}
78
+ post_install_message:
79
+ rdoc_options: []
80
+ require_paths:
81
+ - lib
82
+ required_ruby_version: !ruby/object:Gem::Requirement
83
+ requirements:
84
+ - - ">="
85
+ - !ruby/object:Gem::Version
86
+ version: '0'
87
+ required_rubygems_version: !ruby/object:Gem::Requirement
88
+ requirements:
89
+ - - ">="
90
+ - !ruby/object:Gem::Version
91
+ version: '0'
92
+ requirements: []
93
+ rubyforge_project:
94
+ rubygems_version: 2.5.1
95
+ signing_key:
96
+ specification_version: 4
97
+ summary: Super basic type checking functions in ruby.
98
+ test_files: []