pragma-contract 2.0.1 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65bb088e2e5f2bea1013369379af3335d4c02b381775d376701c0453b8e8f17c
-  data.tar.gz: e2bca105d4a8cc7c3980c8f927bea2468b33a5d342ace9574f5e41afb0a8fc04
+  metadata.gz: ee1d19808a18f852a7889126b040644ff9998dffb001fa385979752d11c1963b
+  data.tar.gz: 494b6b03190618620e2795ef9f61e076f61f1891d20bc1b375b8b06829c84a21
 SHA512:
-  metadata.gz: c9a7cf260d36af1a576d4fa6f16c913b0a643dc4ec67a735a5760213efde02ccd94223b35a43ff601b72755d393a8045402e0ad03281c339c78aa4b93c3fcf36
-  data.tar.gz: 07afc3dcc218d6f3208b18f28456327ea7a9850452c41cae0c96f9022a4c4cfe68a6b0808d436cb37651bc60462f17a7601131ae2e80527b7d8ef8c57428645f
+  metadata.gz: de13ebd9f314c416d083a049cb5a3d853bcdc9703d8b27b5945c79dc13eb558cd7c067dc65f3e8ed51c360b36f905be423a22d54a4edff76eae9aed5c57a5a49
+  data.tar.gz: ba6b2a7bced2b111976b1a6e8a4d5ba766df4721ce974ab47625018d1773eb19f6d1ff31a78a2d8c582e969c527419ccb0508fce4f0ab4fb67b414dade196604

data/.rubocop.yml

@@ -5,6 +5,7 @@ AllCops:
   Include:
     - '**/Gemfile'
     - '**/Rakefile'
+    - '**/*.rb'
   Exclude:
    - 'bin/*'
    - 'db/**/*'
@@ -77,3 +78,6 @@ Style/Documentation:
 Naming/FileName:
   Exclude:
     - '*.gemspec'
+
+Metrics/AbcSize:
+  Enabled: false

data/CHANGELOG.md

@@ -7,6 +7,18 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## [2.1.1]
+
+### Fixed
+
+- Fixed `property` expecting two arguments
+
+## [2.1.0]
+
+### Added
+
+- Implemented the ability to find records when coercing contracts
+
 ## [2.0.1]
 
 ### Fixed
@@ -23,6 +35,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 First Pragma 2 release.
 
-[Unreleased]: https://github.com/pragmarb/pragma-contract/compare/v2.0.1...HEAD
+[Unreleased]: https://github.com/pragmarb/pragma-contract/compare/v2.1.1...HEAD
+[2.1.1]: https://github.com/pragmarb/pragma-contract/compare/v2.1.0...v2.1.1
+[2.1.0]: https://github.com/pragmarb/pragma-contract/compare/v2.0.1...v2.1.0
 [2.0.1]: https://github.com/pragmarb/pragma-contract/compare/v2.0.0...v2.0.1
 [2.0.0]: https://github.com/pragmarb/pragma-contract/compare/v0.1.0...v2.0.0

data/README.md

@@ -92,6 +92,60 @@ module API
 end
 ```
 
+### Model finders
+
+This is a common pattern in API contracts:
+
+```ruby
+module API
+  module V1
+    module Invoice
+      module Contract
+        class Base < Pragma::Contract::Base
+          property :customer
+
+          def customer=(val)
+            super ::Customer.find_by(id: val)
+          end
+        end
+      end
+    end
+  end
+end
+```
+
+Pragma::Contract provides a shorthand syntax:
+
+```ruby
+module API
+  module V1
+    module Invoice
+      module Contract
+        class Base < Pragma::Contract::Base
+          property :customer, type: Customer
+        end
+      end
+    end
+  end
+end
+```
+
+You can also specify a custom column to find by!
+
+```ruby
+module API
+  module V1
+    module Invoice
+      module Contract
+        class Base < Pragma::Contract::Base
+          property :customer, type: Customer, by: :email
+        end
+      end
+    end
+  end
+end
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/pragmarb/pragma-contract.

data/lib/pragma/contract.rb

@@ -1,18 +1,24 @@
 # frozen_string_literal: true
 
+require 'adaptor'
 require 'dry-validation'
 require 'dry-types'
 require 'reform'
 
 require 'pragma/contract/version'
+
 require 'pragma/contract/coercion'
+
+require 'pragma/contract/model_finder/base'
+require 'pragma/contract/model_finder/active_record'
+require 'pragma/contract/model_finder'
+
 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

@@ -14,6 +14,7 @@ module Pragma
       feature Reform::Form::Coercion
       feature Pragma::Contract::Coercion
       feature Reform::Form::Dry
+      feature Pragma::Contract::ModelFinder
 
       property :current_user, virtual: true
     end

data/lib/pragma/contract/model_finder.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Pragma
+  module Contract
+    module ModelFinder
+      include Adaptor::Loader
+      register ActiveRecord
+
+      FINDER_OPTIONS = [:by].freeze
+
+      def self.included(klass)
+        klass.extend ClassMethods
+      end
+
+      module ClassMethods
+        def property(name, options = {})
+          return super if !options[:type] || options[:type].is_a?(Dry::Types::Type)
+
+          property(name, Hash[options.reject { |k, _| k == :type }])
+
+          define_method("#{name}=") do |value|
+            finder = Pragma::Contract::ModelFinder.load_adaptor!(
+              options[:type],
+              Hash[options.select { |k, _| FINDER_OPTIONS.include?(k.to_sym) }]
+            )
+
+            super finder.find(value)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pragma/contract/model_finder/active_record.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Pragma
+  module Contract
+    module ModelFinder
+      class ActiveRecord < Base
+        class << self
+          def supports?(klass)
+            defined?(::ActiveRecord::Base) && klass < ::ActiveRecord::Base
+          end
+        end
+
+        def find(value)
+          klass.find_by(options[:by] => value)
+        end
+      end
+    end
+  end
+end

data/lib/pragma/contract/model_finder/base.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Pragma
+  module Contract
+    module ModelFinder
+      class Base
+        include Adaptor
+
+        class << self
+          def supports?(_klass)
+            fail NotImplementedError
+          end
+        end
+
+        attr_reader :klass, :options
+
+        def initialize(klass, options)
+          @klass = klass
+          @options = { by: :id }.merge(options)
+        end
+
+        def find(_value)
+          fail NotImplementedError
+        end
+      end
+    end
+  end
+end

data/lib/pragma/contract/version.rb

@@ -2,6 +2,6 @@
 
 module Pragma
   module Contract
-    VERSION = '2.0.1'
+    VERSION = '2.1.1'
   end
 end

data/pragma-contract.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.add_dependency 'adaptor', '~> 0.2'
   spec.add_dependency 'dry-types', '~> 0.12.0'
   spec.add_dependency 'dry-validation', '~> 0.11.1'
   spec.add_dependency 'reform', '~> 2.2'

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: pragma-contract
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.1
 platform: ruby
 authors:
 - Alessandro Desantis
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-09 00:00:00.000000000 Z
+date: 2018-08-12 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: adaptor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: dry-types
   requirement: !ruby/object:Gem::Requirement
@@ -157,6 +171,9 @@ files:
 - lib/pragma/contract.rb
 - lib/pragma/contract/base.rb
 - lib/pragma/contract/coercion.rb
+- lib/pragma/contract/model_finder.rb
+- lib/pragma/contract/model_finder/active_record.rb
+- lib/pragma/contract/model_finder/base.rb
 - lib/pragma/contract/types.rb
 - lib/pragma/contract/version.rb
 - pragma-contract.gemspec