carb-types 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 89a3d80561e24e7132ccc3ff050ffefdf800e0f1
+  data.tar.gz: b9f4ef6f3fe980b051f88530f63aaf7163e73c45
+SHA512:
+  metadata.gz: 4d96ecf6e0cfd04e39b24e2eef9dd3065147a511eef40648e7c3044fa0dd170416645a8eaf808dc4bab10453f23361bc775cb33df5a4b69bde8318d1545b1bd0
+  data.tar.gz: 2744c8ef37c2fe503a74624600b93904c8493735bbc4ba78572d0585ce43f17301e1b42455d27d4be9434433ae03dd85dec8adb6ae93d5886ad774c5d0d2ef9d

data/.gitignore

@@ -0,0 +1,39 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+.project
+.directory
+*.swp
+*~
+.DS_Store
+.idea
+.envrc
+.nvmrc
+.ruby-gemset
+.ruby-version
+.rspec-local
+public
+*.backup
+npm-debug.log
+
+# Ignore bundler config
+/.bundle
+/vendor/bundle
+
+# Ignore all logfiles and tempfiles.
+/log/*.log
+/tmp
+/binstubs/
+
+# Ignore user import data
+/data
+
+# YARD
+.yardoc

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

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

data/Gemfile

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

data/LICENSE.md

@@ -0,0 +1,25 @@
+The MIT License (MIT)
+=====================
+
+Copyright © `2016` `Predictable Revenue, Inc.`
+
+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,52 @@
+# carb-types
+
+A set of [dry-types](http://dry-rb.org/gems/dry-types/) to ensure type safety
+for common objects.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'carb-types'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install carb-types
+
+## Usage
+
+Please refer to [dry-types](http://dry-rb.org/gems/dry-types/) for usage. The
+provided types are:
+
+- `Carb::Types::Proc` ensures the object is a proc
+- `Carb::Types::IndifferentSymbol` ensures the object is a symbol, even if
+  string passed
+- `ArrayOfIndifferentSymbols` ensures the object is a valid array of
+  `IndifferentSymbol`
+- `Carb::Types::StringHash` ensures a hash has only string keys
+- `Carb::Types::UUID` ensures a string is a valid UUID
+- `Carb::Types::PG::StringArray` ensures an array is a valid postgres text array
+- `Carb::Types::PG::JSONB` ensures a hashmap, an array or an object are valid
+  JSON for postgres. `JSONBArray`, `JSONBHash` and `JSONBOp` are also provided,
+  ensuring the object is an Array, hash or basic object for JSON
+- `Carb::Types::PG::Bytea` ensures the object is a valid blob for postgres
+- `Carb::Types::PG::CoercibleJSONBHash` ensures the `JSONBHash` can be converted
+  to/from a ruby `Hash`
+- `Carb::Types::PG::Tsvector` ensures the object is a valid postgres tsvector
+
+## 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/Carburetor/carb-types.
+

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,11 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "carb-types"
+
+# 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

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/carb-types.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "carb/types/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "carb-types"
+  spec.version       = Carb::Types::VERSION
+  spec.authors       = ["Fire-Dragon-DoL"]
+  spec.email         = ["francesco.belladonna@gmail.com"]
+
+  spec.summary       = %q{Custom dry-types to ensure type safety}
+  spec.description   = %q{Custom dry-types to ensure type safety}
+  spec.homepage      = "https://github.com/Carburetor/carb-types"
+
+  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_dependency "activesupport"
+  spec.add_dependency "carb-core", ">= 1.0.0"
+  spec.add_dependency "dry-types"
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake",    "~> 11.0"
+  spec.add_development_dependency "rspec",   "~> 3.0"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "pg"
+  spec.add_development_dependency "sequel"
+end

data/lib/carb-types.rb

@@ -0,0 +1 @@
+require "carb/types"

data/lib/carb/types.rb

@@ -0,0 +1,13 @@
+require "carb"
+require "carb/types/version"
+require "carb/types/base"
+require "carb/types/core"
+require "carb/types/proc"
+require "carb/types/uuid"
+require "carb/types/indifferent_symbol"
+require "carb/types/array_of_indifferent_symbols"
+require "carb/types/string_hash"
+
+module Carb::Types
+  include Core
+end

data/lib/carb/types/array_of_indifferent_symbols.rb

@@ -0,0 +1,8 @@
+require "dry-types"
+require "carb"
+require "carb/types/core"
+require "carb/types/indifferent_symbol"
+
+module Carb::Types
+  ArrayOfIndifferentSymbols = Core::Coercible::Array.member(IndifferentSymbol)
+end

data/lib/carb/types/base.rb

@@ -0,0 +1,8 @@
+require "carb"
+require "dry-types"
+
+module Carb::Types
+  module Base
+    Proc = Dry::Types::Definition[::Proc].new(::Proc)
+  end
+end

data/lib/carb/types/core.rb

@@ -0,0 +1,12 @@
+require "carb"
+require "dry-types"
+
+module Carb::Types
+  module Core
+    include Dry::Types.module
+
+    def self.type_define(klass)
+      Dry::Types::Definition[klass].new(klass)
+    end
+  end
+end

data/lib/carb/types/indifferent_symbol.rb

@@ -0,0 +1,12 @@
+require "dry-types"
+require "carb"
+require "carb/types/core"
+
+module Carb::Types
+  IndifferentSymbol = Core::Strict::Symbol.constructor do |input|
+    unless input.respond_to?(:to_sym)
+      raise Dry::Types::ConstraintError.new("#to_sym", input)
+    end
+    input.to_sym
+  end
+end

data/lib/carb/types/pg.rb

@@ -0,0 +1,13 @@
+require "pg"
+require "sequel"
+require "carb"
+
+Sequel.extension(:pg_json_ops, :pg_array_ops, :pg_json, :pg_array)
+
+module Carb::Types
+  module PG
+  end
+end
+
+require "carb/types/pg/raw"
+require "carb/types/pg/core"

data/lib/carb/types/pg/core.rb

@@ -0,0 +1,37 @@
+require "pg"
+require "sequel"
+require "carb"
+require "carb/types/core"
+require "carb/types/pg"
+require "carb/types/pg/raw"
+
+Sequel.extension(:pg_json_ops, :pg_array_ops, :pg_json, :pg_array)
+
+module Carb::Types::PG
+  # Array
+  def self.Array(db_type)
+    Raw::Array.constructor(
+      ->(array) { Sequel.pg_array(array, db_type) }
+    ).meta(type: db_type)
+  end
+
+  StringArray = Raw::Array.constructor(
+    ->(input) { Sequel.pg_array(input.map(&:to_s), :text) }
+  ).meta(type: :text)
+
+  # JSONB
+  JSONBArray = Raw::JSONBArray.constructor(Sequel.method(:pg_jsonb))
+  JSONBHash  = Raw::JSONBHash.constructor(Sequel.method(:pg_jsonb))
+  JSONBOp    = Raw::JSONBOp.constructor(Sequel.method(:pg_jsonb))
+  JSONB      = JSONBArray | JSONBHash | JSONBOp
+  Bytea      = Raw::Bytea.constructor(Sequel::SQL::Blob.method(:new))
+
+  CoercibleJSONBHash = Raw::JSONBHash.constructor(
+    ->(input) { Sequel.pg_jsonb(input.to_h) }
+  )
+
+  # Tsvector
+  Tsvector = ::Carb::Types::Core::Coercible::String.constructor(
+    ->(input) { Sequel.function(:to_tsvector, input.to_s) }
+  )
+end

data/lib/carb/types/pg/raw.rb

@@ -0,0 +1,27 @@
+require "dry-types"
+require "pg"
+require "sequel"
+require "carb"
+require "carb/types/pg"
+require "carb/types/core"
+
+Sequel.extension(:pg_json_ops, :pg_array_ops, :pg_json, :pg_array)
+
+module Carb::Types::PG
+  module Raw
+    types      = ::Carb::Types::Core
+
+    UUID       = types::String
+    Array      = types.type_define(Sequel::Postgres::PGArray)
+    JSONArray  = types.type_define(Sequel::Postgres::JSONArray)
+    JSONHash   = types.type_define(Sequel::Postgres::JSONHash)
+    JSONOp     = types.type_define(Sequel::Postgres::JSONOp)
+    JSON       = JSONArray | JSONHash | JSONOp
+    JSONBArray = types.type_define(Sequel::Postgres::JSONBArray)
+    JSONBHash  = types.type_define(Sequel::Postgres::JSONBHash)
+    JSONBOp    = types.type_define(Sequel::Postgres::JSONBOp)
+    JSONB      = JSONBArray | JSONBHash | JSONBOp
+    Bytea      = types.type_define(Sequel::SQL::Blob)
+    Money      = types::Decimal
+  end
+end

data/lib/carb/types/proc.rb

@@ -0,0 +1,6 @@
+require "carb"
+require "carb/types/base"
+
+module Carb::Types
+  Proc = Base::Proc.constrained(type: ::Proc)
+end

data/lib/carb/types/string_hash.rb

@@ -0,0 +1,10 @@
+require "active_support/core_ext/hash/keys"
+require "carb"
+require "carb/types/core"
+
+module Carb::Types
+  StringHash = Core::Coercible::Hash.constructor do |input|
+    input.to_h.deep_stringify_keys
+  end
+end
+

data/lib/carb/types/uuid.rb

@@ -0,0 +1,14 @@
+require "carb"
+require "carb/types/core"
+
+module Carb::Types
+  UUID = Core::Strict::String.constrained(
+    format: /
+      \A[0-9a-fA-F]{8}
+      -[0-9a-fA-F]{4}
+      -4[0-9a-fA-F]{3}
+      -[89abAB][0-9a-fA-F]{3}
+      -[0-9a-fA-F]{12}\z
+    /ix
+  )
+end

data/lib/carb/types/version.rb

@@ -0,0 +1,5 @@
+module Carb
+  module Types
+    VERSION = "1.0.0"
+  end
+end

metadata

@@ -0,0 +1,192 @@
+--- !ruby/object:Gem::Specification
+name: carb-types
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Fire-Dragon-DoL
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-05-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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'
+- !ruby/object:Gem::Dependency
+  name: carb-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: dry-types
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.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'
+- !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: pg
+  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: sequel
+  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: Custom dry-types to ensure type safety
+email:
+- francesco.belladonna@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- carb-types.gemspec
+- lib/carb-types.rb
+- lib/carb/types.rb
+- lib/carb/types/array_of_indifferent_symbols.rb
+- lib/carb/types/base.rb
+- lib/carb/types/core.rb
+- lib/carb/types/indifferent_symbol.rb
+- lib/carb/types/pg.rb
+- lib/carb/types/pg/core.rb
+- lib/carb/types/pg/raw.rb
+- lib/carb/types/proc.rb
+- lib/carb/types/string_hash.rb
+- lib/carb/types/uuid.rb
+- lib/carb/types/version.rb
+homepage: https://github.com/Carburetor/carb-types
+licenses: []
+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.12
+signing_key: 
+specification_version: 4
+summary: Custom dry-types to ensure type safety
+test_files: []