enotype 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 49b45ee141f7108c88785143cbae350f76dee9dbb6d5dd1acbce7972bc3bbfe6
-  data.tar.gz: 5e3f2de9a97da96a79757a56d2c3be830b3f3ccec01c7392fd437a4bf26fdad6
+  metadata.gz: 696aaec3692ebde4b659d55dfa9204c518c1ef79dbd1cb3e471b8adfefd3b2d3
+  data.tar.gz: 43ac82acba4c279448ce1772df426e7c5ea3171407491807d16255736e5401b6
 SHA512:
-  metadata.gz: 8cc784fcf21d0d73ade3cd036288b953d40f32fe4a8394cbfb92f10610c052b10fa9ce2997d4237b97e9fec9cf09751bf0ace0464851dab3cd0a634bda24d362
-  data.tar.gz: 57d00f2f5c740134ccfbea7b125ab0ea335795bb0d0b2f9b9e200f2bb60d34494abc11feda7c0caeedf9b23ba4dd37f47faf4e5487d11dd4ffa7ea54e6a2da08
+  metadata.gz: 98e65e3c1ab680317b0d7c2f6fe467a21fb3aa8511e247c8eec49527072e4a24969d7e2f21ff5db911f16e3f168f164cfdf4d8feece7358ab69ff125bed6927c
+  data.tar.gz: 5ee2dec7a1fd2c962006a3481e845521ad03fc4ca0a6a931ec849a5913fc2d7fb8474b5b532814967fda8dc15aa220ab829861e95e5461850f3ce26fcb799785

data/README.md

@@ -1,14 +1,234 @@
 # enotype
 
-**A cross-language standard library for types.**
+**A cross-language type library**
 
 ```ruby
 require 'enotype'
 
-Enotype::color('#fff') # returns '#fff'
-Enotype::color('#xyz') # raises 'A color is required, for instance '#B6D918', '#fff' or '#01b'.'
+Enotype::color('#fff') # returns "#fff"
+Enotype::color('#xyz') # raises "A color is required, for instance '#B6D918', '#fff' or '#01b'."
 ```
 
-enotype is a collection of minimalist pure functions that validate and convert type-unsafe `string` representations into type-safe, native types.
+```ruby
+require 'enotype/es' # with localized error messages
+
+Enotype::color('#xyz') # raises "Se requiere un color, por ejemplo '#B6D918', '#fff' o '#01b'."
+```
+
+## Installation
+
+Either add it to your `Gemfile`:
+
+```ruby
+gem 'enotype'
+```
+
+Or install it manually:
+
+```
+gem install enotype
+```
+
+## Features
+
+- Validation and conversion of `string` representations into language-native types.
+- Implemented as a collection of minimalist functions, so called *loaders*.
+- Zero-cost localization (currently `de`, `en`, `es`) through statically generated code.
+- Generically usable in a multitude of contexts through a plain and simple design.
+- Standard type library for the [eno notation language](https://eno-lang.org).
+
+## Documentation
+
+### boolean
+
+```ruby
+require 'enotype'
+
+Enotype::boolean('true') # returns true
+```
+
+`'true'` returns `true`.  
+`'false'` returns `false`.  
+`'yes'` returns `true`.  
+`'no'` returns `false`.  
+`'nope'` raises an exception.
+### color
+
+```ruby
+require 'enotype'
+
+Enotype::color('#abcdef') # returns '#abcdef'
+```
+
+`'#abcdef'` returns `'#abcdef'`.  
+`'#ABCDEF'` returns `'#ABCDEF'`.  
+`'#012345'` returns `'#012345'`.  
+`'#678'` returns `'#678'`.  
+`'#89a'` returns `'#89a'`.  
+`'#ab'` raises an exception.  
+`'#abcd'` raises an exception.  
+`'#abcde'` raises an exception.  
+`'#bcdefg'` raises an exception.  
+`'blue'` raises an exception.
+### comma_separated
+
+```ruby
+require 'enotype'
+
+Enotype::comma_separated('one,two,three') # returns ['one', 'two', 'three']
+```
+
+`'one,two,three'` returns `['one', 'two', 'three']`.  
+`' one,two,three '` returns `['one', 'two', 'three']`.  
+`'one , two , three'` returns `['one', 'two', 'three']`.  
+`' one , two , three '` returns `['one', 'two', 'three']`.  
+`',,'` returns `['', '', '']`.  
+`'one two three'` returns `['one two three']`.  
+`'one;two;three'` returns `['one;two;three']`.  
+`'   '` returns `['']`.
+### date
+
+```ruby
+require 'enotype'
+
+Enotype::date('1992-02-02') # returns Time.utc(1992, 2, 2)
+```
+
+`'1992-02-02'` returns `Time.utc(1992, 2, 2)`.  
+`'1990'` raises an exception.  
+`'1991-01'` raises an exception.  
+`'1993-03-03T1920+01:00'` raises an exception.  
+`'1994-04-04T1920:30+01:00'` raises an exception.  
+`'1995-05-05T1920:30.45+01:00'` raises an exception.  
+`'1996-06-06T0815:30-05:00'` raises an exception.  
+`'1997-07-07T1315:30Z'` raises an exception.  
+`'2002 12 14'` raises an exception.  
+`'2002-12-14 20:15'` raises an exception.  
+`'January'` raises an exception.  
+`'13:00'` raises an exception.
+### datetime
+
+```ruby
+require 'enotype'
+
+Enotype::datetime('1990') # returns Time.utc(1990, 1, 1)
+```
+
+`'1990'` returns `Time.utc(1990, 1, 1)`.  
+`'1991-01'` returns `Time.utc(1991, 1, 1)`.  
+`'1992-02-02'` returns `Time.utc(1992, 2, 2)`.  
+`'1993-03-03T19:20+01:00'` returns `Time.utc(1993, 3, 3, 18, 20)`.  
+`'1994-04-04T19:20:30+01:00'` returns `Time.new(1994, 4, 4, 19, 20, 30, '+01:00')`.  
+`'1995-05-05T19:20:30.450+01:00'` returns `Time.new(1995, 5, 5, 19, 20, 30.450, '+01:00')`.  
+`'1996-06-06T08:15:30-05:00'` returns `Time.new(1996, 6, 6, 8, 15, 30, '-05:00')`.  
+`'1997-07-07T13:15:30Z'` returns `Time.utc(1997, 7, 7, 13, 15, 30)`.  
+`'2002 12 14'` raises an exception.  
+`'2002-12-14 20:15'` raises an exception.  
+`'January'` raises an exception.  
+`'13:00'` raises an exception.
+### email
+
+```ruby
+require 'enotype'
+
+Enotype::email('john.doe@eno-lang.org') # returns 'john.doe@eno-lang.org'
+```
+
+`'john.doe@eno-lang.org'` returns `'john.doe@eno-lang.org'`.  
+`'john.doe@eno-lang'` raises an exception.  
+`'@eno-lang.org'` raises an exception.  
+`'john.doe@.org'` raises an exception.
+### float
+
+```ruby
+require 'enotype'
+
+Enotype::float('42') # returns 42.0
+```
+
+`'42'` returns `42.0`.  
+`'-42'` returns `-42.0`.  
+`'42.0'` returns `42.0`.  
+`'42,0'` raises an exception.  
+`'4 2.0'` raises an exception.  
+`'fortytwo'` raises an exception.
+### integer
+
+```ruby
+require 'enotype'
+
+Enotype::integer('42') # returns 42
+```
+
+`'42'` returns `42`.  
+`'-42'` returns `-42`.  
+`'42.0'` raises an exception.  
+`'42,0'` raises an exception.  
+`'4 2'` raises an exception.  
+`'fortytwo'` raises an exception.
+### json
+
+```ruby
+require 'enotype'
+
+Enotype::json('{ "valid": true }') # returns { 'valid' => true }
+```
+
+`'{ "valid": true }'` returns `{ 'valid' => true }`.  
+`'42'` returns `42`.  
+`'["valid", true]'` returns `['valid', true]`.  
+`'invalid'` raises an exception.  
+`'{ invalid: true }'` raises an exception.  
+`'{ "invalid": true, }'` raises an exception.
+### lat_lng
+
+```ruby
+require 'enotype'
+
+Enotype::lat_lng('48.205870, 16.413690') # returns { lat: 48.205870, lng: 16.413690 }
+```
+
+`'48.205870, 16.413690'` returns `{ lat: 48.205870, lng: 16.413690 }`.  
+`'41.25, -120.9762'` returns `{ lat: 41.25, lng: -120.9762 }`.  
+`'-31.96, 115.84'` returns `{ lat: -31.96, lng: 115.84 }`.  
+`'90, 0'` returns `{ lat: 90, lng: 0 }`.  
+`'   0   ,   0   '` returns `{ lat: 0, lng: 0 }`.  
+`'-0,-0'` returns `{ lat: -0, lng: -0 }`.  
+`'1000,10'` raises an exception.  
+`'10,1000'` raises an exception.  
+`'48.205870,'` raises an exception.  
+`', 16.413690'` raises an exception.  
+`'48,205870, 16,413690'` raises an exception.
+### slug
+
+```ruby
+require 'enotype'
+
+Enotype::slug('eno-lang-article') # returns 'eno-lang-article'
+```
+
+`'eno-lang-article'` returns `'eno-lang-article'`.  
+`'eno_lang_article'` returns `'eno_lang_article'`.  
+`'eno-lang-article!'` raises an exception.  
+`'%eno-lang-article'` raises an exception.  
+`'eno lang article'` raises an exception.  
+`'enö-läng-ärticle'` raises an exception.  
+`'énó-láng-ártíclé'` raises an exception.
+### url
+
+```ruby
+require 'enotype'
+
+Enotype::url('http://www.valid.com') # returns 'http://www.valid.com'
+```
 
-It is the standard type library for the [eno notation language](https://eno-lang.org) but can be utilized in a multitude of other contexts as well.
+`'http://www.valid.com'` returns `'http://www.valid.com'`.  
+`'https://valid.com'` returns `'https://valid.com'`.  
+`'https://www.valid.com'` returns `'https://www.valid.com'`.  
+`'invalid'` raises an exception.  
+`'www.invalid'` raises an exception.  
+`'www.invalid.com'` raises an exception.  
+`'htp://www.invalid.com'` raises an exception.  
+`'http:/invalid.com'` raises an exception.  
+`'https//invalid.com'` raises an exception.  
+`'https://invalid'` raises an exception.

data/lib/enotype/de.rb

@@ -7,6 +7,7 @@ EMAIL_REGEXP = /^\s*[^@\s]+@[^@\s]+\.[^@\s]+\s*$/
 FLOAT_REGEXP = /^\s*-?\d+(\.\d+)?\s*$/
 INTEGER_REGEXP = /^\s*-?\d+\s*$/
 LAT_LNG_REGEXP = /^\s*(-?\d{1,3}(?:\.\d+)?)\s*,\s*(-?\d{1,3}(?:\.\d+)?)\s*$/
+SLUG_REGEXP = /^[0-9a-z\-_]+$/
 URL_REGEXP = /^\s*https?:\/\/[^\s.]+\.\S+\s*$/
 
 module Enotype
@@ -95,6 +96,12 @@ module Enotype
     { lat: match[1].to_f, lng: match[2].to_f }
   end
   
+  def self.slug(value)
+    raise 'Ein Slug wie zum Beispiel \'blog_post\', \'eno-notation\' oder \'62-dinge\' ist erforderlich - nur die Zeichen a-z, 0-9, \'-\' und \'_\' sind erlaubt.' unless value.match(SLUG_REGEXP)
+  
+    value
+  end
+  
   def self.url(value)
     raise 'Eine valide URL ist erforderlich, zum Beispiel \'https://eno-lang.org\'.' unless value.match(URL_REGEXP)
   

data/lib/enotype/en.rb

@@ -7,6 +7,7 @@ EMAIL_REGEXP = /^\s*[^@\s]+@[^@\s]+\.[^@\s]+\s*$/
 FLOAT_REGEXP = /^\s*-?\d+(\.\d+)?\s*$/
 INTEGER_REGEXP = /^\s*-?\d+\s*$/
 LAT_LNG_REGEXP = /^\s*(-?\d{1,3}(?:\.\d+)?)\s*,\s*(-?\d{1,3}(?:\.\d+)?)\s*$/
+SLUG_REGEXP = /^[0-9a-z\-_]+$/
 URL_REGEXP = /^\s*https?:\/\/[^\s.]+\.\S+\s*$/
 
 module Enotype
@@ -95,6 +96,12 @@ module Enotype
     { lat: match[1].to_f, lng: match[2].to_f }
   end
   
+  def self.slug(value)
+    raise 'A slug like for instance \'blog_post\', \'eno-notation\' or \'62-things\' is required - only the characters a-z, 0-9, \'-\' und \'_\' are allowed.' unless value.match(SLUG_REGEXP)
+  
+    value
+  end
+  
   def self.url(value)
     raise 'A valid URL is required, for instance \'https://eno-lang.org\'.' unless value.match(URL_REGEXP)
   

data/lib/enotype/es.rb

@@ -7,6 +7,7 @@ EMAIL_REGEXP = /^\s*[^@\s]+@[^@\s]+\.[^@\s]+\s*$/
 FLOAT_REGEXP = /^\s*-?\d+(\.\d+)?\s*$/
 INTEGER_REGEXP = /^\s*-?\d+\s*$/
 LAT_LNG_REGEXP = /^\s*(-?\d{1,3}(?:\.\d+)?)\s*,\s*(-?\d{1,3}(?:\.\d+)?)\s*$/
+SLUG_REGEXP = /^[0-9a-z\-_]+$/
 URL_REGEXP = /^\s*https?:\/\/[^\s.]+\.\S+\s*$/
 
 module Enotype
@@ -95,6 +96,12 @@ module Enotype
     { lat: match[1].to_f, lng: match[2].to_f }
   end
   
+  def self.slug(value)
+    raise 'Se requiere un slug como por ejemplo \'blog_post\', \'eno-notacion\' o \'62-cosas\' - solo los caracteres a-z, 0-9, \'-\' und \'_\' son permitidos.' unless value.match(SLUG_REGEXP)
+  
+    value
+  end
+  
   def self.url(value)
     raise 'Se requiere un URL valido, por ejemplo \'https://eno-lang.org\'.' unless value.match(URL_REGEXP)
   

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: enotype
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Simon Repp
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-21 00:00:00.000000000 Z
+date: 2019-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -24,8 +24,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.8'
-description: enotype is a collection of minimalist pure functions that validate and
-  convert type-unsafe string representations into type-safe, native types.
+description: Validation and conversion of `string` representations into language-native
+  types
 email: simon@fdpl.io
 executables: []
 extensions: []
@@ -37,7 +37,7 @@ files:
 - lib/enotype/de.rb
 - lib/enotype/en.rb
 - lib/enotype/es.rb
-homepage: https://eno-lang.org/
+homepage: https://eno-lang.org/enotype/
 licenses:
 - MIT
 metadata: {}
@@ -60,5 +60,5 @@ rubyforge_project:
 rubygems_version: 2.7.8
 signing_key: 
 specification_version: 4
-summary: A cross-language standard library for types
+summary: A cross-language type library
 test_files: []