definition 0.1.0.rc1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5d4178b9d52b38f362ceeefc4e4b593c08bc1db136f39f43791c146890eebeec
+  data.tar.gz: 35a2df7826b4d9e77fa425711fcbff1ba1024438b355240a5aa5ee79a535e2d5
+SHA512:
+  metadata.gz: 1f249e44ce43c29716f6943a8373399797d928f1796d42f6ead9f13261595e297cf4dc37418ef99d53717f6c57a5988ae78c01bab3c5cd91e227b3e150b7efae
+  data.tar.gz: 413f8ccf960d01faad85221108feda1b3c7ac41a0766c76d36872e58484f65d2c043a1f71d6fdde2de05814908b1325caeb0e2953f46281f625fe26eefc7f3db

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/bin/
+*.swp
+spec/examples.txt

data/.rspec

@@ -0,0 +1,2 @@
+--format p
+--color

data/.rubocop.yml

@@ -0,0 +1,77 @@
+require: 
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.3
+    
+Metrics/LineLength:
+  Max: 119
+  Exclude:
+    - Guardfile
+    - Gemfile
+  IgnoreCopDirectives: true
+
+Metrics/BlockLength:
+  Exclude:
+    - '*.gemspec'
+    - '**/*.rake'
+    - 'spec/**/*'
+
+Metrics/MethodLength:
+  Max: 11
+
+
+Style/Documentation:
+  Enabled: false
+
+Style/AlignHash:
+  EnforcedColonStyle: table
+  EnforcedHashRocketStyle: table
+
+Layout/AlignHash:
+  EnforcedColonStyle: table
+  EnforcedHashRocketStyle: table
+
+Style/HashSyntax:
+  EnforcedStyle: ruby19_no_mixed_keys
+
+Style/MultilineOperationIndentation:
+  Description: Checks indentation of binary operations that span more than one line.
+  EnforcedStyle: indented
+
+Layout/MultilineOperationIndentation:
+  Description: Checks indentation of binary operations that span more than one line.
+  EnforcedStyle: indented
+
+Style/RaiseArgs:
+  EnforcedStyle: compact
+
+Style/SignalException:
+  EnforcedStyle: only_raise
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+
+
+RSpec/DescribeClass:
+  Exclude:
+    - spec/integration/**/*
+
+RSpec/MessageSpies:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/NamedSubject:
+  Enabled: false
+
+RSpec/NestedGroups:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/MessageExpectation:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+rvm:
+  - jruby-9.1.17.0 # ruby 2.3
+  - jruby-9.2.0.0 # ruby 2.5
+  - jruby-head
+  - 2.3.0
+  - 2.4.0
+  - 2.5.0
+  - ruby-head
+jobs:
+  include:
+    - stage: linting
+      rvm: ruby-head
+      script: bundle exec rake rubocop

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in definition.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+directories(%w[lib spec])
+  .select { |d| Dir.exist?(d) ? d : UI.warning("Directory #{d} does not exist") }
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do # rubocop:disable Metrics/BlockLength
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+  # Rails files
+  rails = dsl.rails(view_extensions: %w[erb haml slim])
+  dsl.watch_spec_files_for(rails.app_files)
+  dsl.watch_spec_files_for(rails.views)
+
+  watch(rails.controllers) do |m|
+    [
+      rspec.spec.call("routing/#{m[1]}_routing"),
+      rspec.spec.call("controllers/#{m[1]}_controller"),
+      rspec.spec.call("acceptance/#{m[1]}")
+    ]
+  end
+
+  # Rails config changes
+  watch(rails.spec_helper)     { rspec.spec_dir }
+  watch(rails.routes)          { "#{rspec.spec_dir}/routing" }
+  watch(rails.app_controller)  { "#{rspec.spec_dir}/controllers" }
+
+  # Capybara features specs
+  watch(rails.view_dirs)     { |m| rspec.spec.call("features/#{m[1]}") }
+  watch(rails.layouts)       { |m| rspec.spec.call("features/#{m[1]}") }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
+    Dir[File.join("**/#{m[1]}.feature")][0] || "spec/acceptance"
+  end
+end

data/README.md

@@ -0,0 +1,205 @@
+# Definition
+
+[![Build Status](https://travis-ci.org/Goltergaul/definition.svg?branch=master)][travis]
+[![Gem Version](https://badge.fury.io/rb/definition.svg)][rubygems]
+
+Simple and composable validation and coercion of data structures
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'definition'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install definition
+
+## Usage
+
+Definitions can be used to validate data structures like for example Hashes:
+
+```ruby
+schema = Definition.Keys do
+  required :first_name, Definition.Type(String)
+  required :last_name, Definition.Type(String)
+  optional :birthday, Definition.Type(Date)
+end
+
+conform_result = schema.conform({first_name: "John", last_name: "Doe", birthday: Date.today})
+conform_result.passed? # => true
+
+conform_result = schema.conform({first_name: "John", last_name: "Doe", birthday: "2018/02/09"})
+conform_result.passed? # => false
+conform_result.error_message # => hash fails validation for key birthday: { Is of type String instead of Date }
+```
+
+But it can also transform those data structures at the same time. The following
+example shows how a Unix timestamp in milliseconds can be transformed to a Time
+object while validating:
+
+```ruby
+milliseconds_time_definition = Definition.Lambda(:milliseconds_time) do |value|
+  conform_with(Time.at(value.to_r / 1000).utc) if value.is_a?(Integer)
+end
+
+schema = Definition.Keys do
+  required :title, Definition.Type(String)
+  required :body, Definition.Type(String)
+  optional :publication_date, milliseconds_time_definition
+end
+
+conform_result = schema.conform({title: "My first blog post", body: "Shortest one ever!", publication_date: 1546170180339})
+conform_result.passed? # => true
+conform_result.value # => {title: "My first blog post", body: "Shortest one ever!", publication_date: 2018-12-30 11:43:00 UTC}
+```
+
+Because definitions do not only validate input but also transform input, we use
+the term `conform` which stands for validation and coercion.
+
+### Conforming Hashes
+
+Hashes can be conformed by using the `Keys` definition. It allows you to configure
+required and optional attributes. The first argument of `required` and `optional`
+takes either Symbols or Strings. If you use a Symbol, then the validated Hash
+needs to have a Symbol key with that name, otherwise a string key.
+
+The key definition will also fail if the input value contains extra keys.
+
+```ruby
+Definition.Keys do
+  required :title, Definition.Type(String)
+  optional :publication_date, Definition.Type(Date)
+end
+```
+
+### Validating types
+
+This will validate that the value is of the specified type.
+
+```ruby
+Definition.Type(String)
+Definition.Type(Float)
+Definition.Type(MyClass)
+
+Definition.Type(MyClass).conform(0.1).passed? # => false
+Definition.Type(MyClass).conform(MyClass.new).passed? # => true
+```
+
+### Conforming types
+
+This will validate that the value is of the specified type. But if its not it will
+try to coerce it into that type. This Definition works only with primitive types.
+
+```ruby
+Definition.CoercibleType(String) # Uses String() to coerce values
+Definition.CoercibleType(Float) # Uses Float() to coerce values
+
+Definition.CoercibleType(Float).conform("0.1").passed? # => true
+Definition.CoercibleType(Float).conform("0.1").value # => 0.1
+```
+
+### Combining multiple definitions with "And"
+
+```ruby
+Definition.And(definition1, definition2)
+```
+
+This definition will only conform if all definitions conform. The definitions will
+be processed from left to right and the output of the previous will be the input
+of the next.
+
+### Combining multiple definitions with "Or"
+
+```ruby
+Definition.Or(definition1, definition2)
+```
+
+This definition will conform if at least one definition conforms. The definitions will
+be processed from left to right and stop as soon as a definition conforms. The output
+of that definition will be the output of the Or definition.
+
+### Conforming array values with "Each"
+
+```ruby
+Definition.Each(item_definition)
+
+Definition.Each(Definition.Type(Integer)).conform([1,2,3,"4"]).error_message
+# => Not all items conform with each: { Item "4" did not conform to each: { Is of type String instead of Integer } }
+```
+
+This definition will only conform if all elements of the value conform to the
+`item_definition`.
+
+### Conforming with custom lambda functions
+
+```ruby
+Definition.Lambda(:password) do |value|
+  matches = Regexp.new(/^
+    (?=.*[a-z]) # should contain at least one lower case letter
+    (?=.*[A-Z]) # should contain at least one upper case letter
+    (?=.*\d)    # should contain at least one digit
+    .{6,50}     # should be between 6 and 50 characters long
+    $/x).match(value.to_s)
+  conform_with(value) if matches
+end
+```
+
+This definition can be used to build any custom validation or coercion you want.
+The example above makes sure that a password conforms with a set of rules.
+
+The block gets the input value as argument and you can do any transformation or
+validation on it that you want. If you determine that the value is valid, then
+you must call `conform_with` and pass it the value you want to return. This can
+either be the original value or any transformed version of it. By not calling
+`conform_with` you tell the definition to fail for the current input value.
+
+The first argument of `Definition.Lambda` is a name you can give this definition.
+It will only be used in the error message to make it more readable.
+
+### Composing Definitions
+
+Definitions are reusable and can be easily composed:
+
+```ruby
+country_code_definition = Definition.Lambda(:iso_county_code) do |value|
+  if iso_code = IsoCountryCodes.find(value)
+    conform_with(iso_code.alpha2)
+  end
+end
+
+address_definition = Definition.Keys do
+  required :street, Definition.Type(String)
+  required :postal_code, Definition.Type(String)
+  required :country_code, country_code_definition
+end
+
+order = Definition.Keys do
+  required :user, user_definition
+  required :invoice_address, address_definition
+  required :shipping_address, address_definition
+end
+```
+
+### Examples
+
+Check out the [integration specs](./spec/integration) for more usage examples.
+
+## 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/Goltergaul/definition.
+
+[travis]: https://travis-ci.org/Goltergaul/definition
+[rubygems]: https://rubygems.org/gems/definition

data/Rakefile

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+
+task :init do
+  Rake::Task["rubocop:install"].execute
+end
+
+require "rubocop/rake_task"
+RuboCop::RakeTask.new
+namespace :rubocop do
+  desc "Install Rubocop as pre-commit hook"
+  task :install do
+    require "rubocop_runner"
+    RubocopRunner.install
+  end
+end

data/definition.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "definition/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "definition"
+  spec.version       = Definition::VERSION
+  spec.authors       = ["Dominik Goltermann"]
+  spec.email         = ["dominik@goltermann.cc"]
+
+  spec.summary       = "Simple and composable validation and coercion of data structures inspired by clojure specs"
+  spec.homepage      = "https://github.com/Goltergaul/definition"
+  spec.license       = "MIT"
+
+  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 "approvals", "~> 0.0"
+  spec.add_development_dependency "awesome_print"
+  spec.add_development_dependency "benchmark-ips"
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "fuubar"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec-its", "~> 1.2"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "rubocop-rspec"
+  spec.add_development_dependency "rubocop_runner"
+  spec.add_development_dependency "timecop"
+end