pragma-contract 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9c118ad0fbcea335eee361aa0760db1a996d9369
+  data.tar.gz: 4d76ee82b1672ba284c875d3b1ddf15667c836cd
+SHA512:
+  metadata.gz: e7051799891c50fa759c84e759659df93406d138a3b04000c1835bc183fe79e3080f24522e4e7e253b2b247b42142f1729f02ab295f2efb78ecced91330786fc
+  data.tar.gz: 3ec1278a66a617df022b9f79329c4641aa659b029f861aae221e69fc134e77d1da1d5adce25bdbbe33a3673c939b5c41426921cd8fe5ecf7894aef244dfafd94

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,69 @@
+require: rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.3
+  Include:
+    - '**/Gemfile'
+    - '**/Rakefile'
+  Exclude:
+   - 'bin/*'
+   - 'db/**/*'
+   - 'vendor/bundle/**/*'
+   - 'spec/spec_helper.rb'
+   - 'spec/rails_helper.rb'
+   - 'spec/support/**/*'
+   - 'config/**/*'
+   - '**/Rakefile'
+   - '**/Gemfile'
+
+RSpec/DescribeClass:
+  Exclude:
+    - 'spec/requests/**/*'
+
+Style/BlockDelimiters:
+  Exclude:
+    - 'spec/**/*'
+
+Style/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Style/ClosingParenthesisIndentation:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 100
+  AllowURI: true
+
+Style/FirstParameterIndentation:
+  Enabled: false
+
+Style/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Style/IndentArray:
+  EnforcedStyle: consistent
+
+Style/IndentHash:
+  EnforcedStyle: consistent
+
+Style/SignalException:
+  EnforcedStyle: semantic
+
+Style/BracesAroundHashParameters:
+  EnforcedStyle: context_dependent
+
+Lint/EndAlignment:
+  AlignWith: variable
+  AutoCorrect: true
+
+Style/AndOr:
+  EnforcedStyle: conditionals
+
+Style/MultilineBlockChain:
+  Enabled: false
+
+RSpec/NamedSubject:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false

data/.travis.yml

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Alessandro Desantis
+
+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,102 @@
+# Pragma::Contract
+
+[![Build Status](https://img.shields.io/travis/pragmarb/pragma-contract.svg?maxAge=3600&style=flat-square)](https://travis-ci.org/pragmarb/pragma-contract)
+[![Dependency Status](https://img.shields.io/gemnasium/pragmarb/pragma-contract.svg?maxAge=3600&style=flat-square)](https://gemnasium.com/github.com/pragmarb/pragma-contract)
+[![Code Climate](https://img.shields.io/codeclimate/github/pragmarb/pragma-contract.svg?maxAge=3600&style=flat-square)](https://codeclimate.com/github/pragmarb/pragma-contract)
+[![Coveralls](https://img.shields.io/coveralls/pragmarb/pragma-contract.svg?maxAge=3600&style=flat-square)](https://coveralls.io/github/pragmarb/pragma-contract)
+
+Contracts are form objects on steroids for your JSON API.
+
+They are built on top of [Reform](https://github.com/apotonick/reform).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pragma-contract'
+```
+
+And then execute:
+
+```console
+$ bundle
+```
+
+Or install it yourself as:
+
+```console
+$ gem install pragma-contract
+```
+
+## Usage
+
+To create a contract, simply inherit from `Pragma::Contract::Base`:
+
+```ruby
+module API
+  module V1
+    module Post
+      module Contract
+        class Base < Pragma::Contract::Base
+          property :title
+          property :body
+        end
+      end
+    end
+  end
+end
+```
+
+Since Pragma::Contract is built on top of [Reform](https://github.com/apotonick/reform), you should
+consult [its documentation](http://trailblazer.to/gems/reform/) for the basic usage of contracts;
+the rest of this section only covers the features provided specifically by Pragma::Contract.
+
+### Coercion
+
+Pragma::Contract supports Reform coercion through the [dry-types](https://github.com/dry-rb/dry-types)
+gem.
+
+You can access types with the `Pragma::Contract::Types` module.
+
+```ruby
+module API
+  module V1
+    module Post
+      module Contract
+        class Base < Pragma::Contract::Base
+          property :title, type: Pragma::Contract::Types::Coercible::String
+          property :body, type: Pragma::Contract::Types::Coercible::String
+          property :published_at, type: Pragma::Contract::Types::Form::Date
+        end
+      end
+    end
+  end
+end
+```
+
+Helpers are also provided as a shorthand syntax:
+
+```ruby
+module API
+  module V1
+    module Post
+      module Contract
+        class Base < Pragma::Contract::Base
+          property :title, type: coercible(:string)
+          property :body, type: coercible(:string)
+          property :published_at, type: form(:date)
+        end
+      end
+    end
+  end
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/pragmarb/pragma-contract.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

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,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "pragma/contract"
+
+# 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

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/lib/pragma/contract.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+require 'dry-validation'
+require 'dry-types'
+require 'reform'
+
+require 'pragma/contract/version'
+require 'pragma/contract/base'
+require 'pragma/contract/types'
+
+module Pragma
+  # Form objects on steroids for your HTTP API.
+  #
+  # @author Alessandro Desantis
+  module Contract
+  end
+end

data/lib/pragma/contract/base.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+require 'reform/form/coercion'
+require 'reform/form/dry'
+
+module Pragma
+  module Contract
+    # This is the base contract that all of your resource-specific contracts should inherit from.
+    #
+    # It's just an extension of +Reform::Form+ with some helper methods for coercion.
+    #
+    # @author Alessandro Desantis
+    class Base < Reform::Form
+      feature Coercion
+      feature Dry
+
+      class << self
+        protected
+
+        def strict(type)
+          build_type 'Strict', type
+        end
+
+        def coercible(type)
+          build_type 'Coercible', type
+        end
+
+        def form(type)
+          build_type 'Form', type
+        end
+
+        def json(type)
+          build_type 'Json', type
+        end
+
+        def maybe_strict(type)
+          build_type 'Maybe::Strict', type
+        end
+
+        def maybe_coercible(type)
+          build_type 'Maybe::Coercible', type
+        end
+
+        private
+
+        def build_type(namespace, type)
+          Object.const_get "Pragma::Contract::Types::#{namespace}::#{type.to_s.capitalize}"
+        end
+      end
+    end
+  end
+end

data/lib/pragma/contract/types.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+module Pragma
+  module Contract
+    # This module provides access to coercion types.
+    #
+    # @author Alessandro Desantis
+    module Types
+      include Dry::Types.module
+    end
+  end
+end

data/lib/pragma/contract/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+module Pragma
+  module Contract
+    VERSION = '0.1.0'
+  end
+end

data/pragma-contract.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pragma/contract/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "pragma-contract"
+  spec.version       = Pragma::Contract::VERSION
+  spec.authors       = ["Alessandro Desantis"]
+  spec.email         = ["desa.alessandro@gmail.com"]
+
+  spec.summary       = 'Form objects on steroids for your HTTP API.'
+  spec.homepage      = "https://github.com/pragmarb/pragma-contract"
+  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_dependency 'reform', '~> 2.2'
+  spec.add_dependency 'dry-types', '~> 0.9'
+  spec.add_dependency 'dry-validation', '~> 0.10'
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "rubocop-rspec"
+  spec.add_development_dependency "coveralls"
+end

metadata

@@ -0,0 +1,185 @@
+--- !ruby/object:Gem::Specification
+name: pragma-contract
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alessandro Desantis
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: reform
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: dry-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: dry-validation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !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: 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: rspec
+  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: rubocop
+  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: rubocop-rspec
+  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: coveralls
+  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: 
+email:
+- desa.alessandro@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/pragma/contract.rb
+- lib/pragma/contract/base.rb
+- lib/pragma/contract/types.rb
+- lib/pragma/contract/version.rb
+- pragma-contract.gemspec
+homepage: https://github.com/pragmarb/pragma-contract
+licenses:
+- MIT
+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.5.2
+signing_key: 
+specification_version: 4
+summary: Form objects on steroids for your HTTP API.
+test_files: []