interface-dsl 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2142d61ffe6b00c83f9bfd970a8a20c6b1165e5d
-  data.tar.gz: 9cd214a3f86e8a7900c94b0f83340f076826856d
+  metadata.gz: a08f65100277da590913ecc15c42d7c5428a8d42
+  data.tar.gz: 17227276991c60ae9f4e9dee377492666c0a085d
 SHA512:
-  metadata.gz: 4392b14667b9e0d09139c70c410472fe0852273a3f3d5890def2772fefdce717923272a106413c164a13e29930590c6c677d6fcf0f2fe4fc26e6a1db7242f5fc
-  data.tar.gz: 109b67c57a3c33763669f5f0ef06c92aebbe1e10e1932f02b8b6c42ee554b356eda662d03cc90d62f5c28ba51f208edd72d27caf7f0f57fbdaab562b9a055fc0
+  metadata.gz: 7b430dfe570938c708800edb0af3acab804552a4ca390167f560cd00b2ad679e75b1f20f9fc704eb9bd57339565c015c82fcf66cf3fc5e20610c01a404921001
+  data.tar.gz: 8208b4c19043b6328d0d924ecc084685828d1759d98c4c1c9ef1b477095b8c86c752ec9d2bcb7c5bcbbb0d1dd70a78c5f4dfc7e2503a9e11dfd9307df1eccf3e

data/Gemfile

@@ -3,5 +3,6 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in interface-dsl.gemspec
 gemspec
 
+gem 'dry-validation'
 gem 'factorymethods'
 gem 'hashie'

data/README.md

@@ -1,4 +1,4 @@
-# Interface::Dsl
+# Interface::DSL
 
 ## Installation
 
@@ -47,12 +47,12 @@ class CodeMonkeyAPI
   extend Interface::DSL
 
   # Define some interface
-  interface(:midnight_api) do |api|
+  interface(:midnight_api) do
 
     # Define some endpoint
-    api.defpoint(:emergency_push) do |op|
-      op.describe "Push the code, fall asleep"
-      op.implementation MidnightCodingOperation
+    defpoint(:emergency_push) do |op|
+      describe "Push the code, fall asleep"
+      handler  MidnightCodingOperation
     end
   end
 end
@@ -76,6 +76,74 @@ MidnightCoderAPI = CodeMonkeyAPI.midnight_api # specific API
 MidnightCoderAPI.emergency_push.call          # usage
 ```
 
+## [HOT] Extend your API at any relevant point
+
+```ruby
+# Our BASE API class
+class HumanoidAPI
+  # Enable DSL
+  extend Interface::DSL
+
+  # declare main API
+  interface(:base_functions) do
+    defpoint(:jump) do
+      describe "Do jump!"
+      handler  BaseRobotJump
+    end
+  end
+end
+
+# API Extension class
+class JumpExtension
+  # Enable DSL
+  extend Interface::DSL
+
+  # declare extended API
+  interface(:jumping) do
+    defpoint(:on_one_leg) do
+      describe "Carefully jumps on one leg"
+      handler RobotJumpingMaster
+    end
+  end
+end
+```
+
+Current legitimate API for HumanoidAPI is
+
+```ruby
+HumanoidAPI.base_functions.jump
+```
+
+Let's extend it with `JumpExtension`
+```ruby
+HumanoidAPI.base_functions.extend_api(as: 'weird', with_class: JumpExtension)
+```
+
+We've just declaratively extended our API to
+```ruby
+HumanoidAPI.base_functions.jump
+HumanoidAPI.base_functions.weird.jumping.on_one_leg
+```
+
+## [WIP] Declare contract for input data by means of dry-validation (available in [input-validation branch](https://github.com/o-kurnenkov/interface-dsl/tree/input-validation))
+```ruby
+  interface(:midnight_api) do
+    defpoint(:emergency_push) do
+      describe "Push the code, fall asleep"
+      handler  MidnightCodingOperation
+
+      # contract \
+      contract Dry::Validation.Schema do
+        required(:path_to_bed).schema do
+          required(:room).filled
+        end
+      end
+      # contract /
+    end
+  end
+```
+
+
 ## 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.

data/interface-dsl.gemspec

@@ -16,10 +16,13 @@ Gem::Specification.new do |spec|
   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_runtime_dependency 'dry-validation'
+
   spec.add_runtime_dependency 'hashie', '~> 3.0'
   spec.add_runtime_dependency 'dry-configurable', '~> 0.3'
   spec.add_runtime_dependency 'factorymethods', '~> 1.0'

data/lib/interface/dsl/version.rb

@@ -1,5 +1,5 @@
 module Interface
   module Dsl
-    VERSION = "0.1.3"
+    VERSION = "0.1.4"
   end
 end

data/lib/interface/dsl.rb

@@ -15,7 +15,7 @@ module Interface
       end
 
       interfaces.merge!(name => ::Interface::PortGroup.new(name, self).tap do |group|
-        yield(group)
+        group.instance_eval(&block)
       end)
     end
 
@@ -89,7 +89,7 @@ module Interface
     end
 
     def define_entity(name, &block)
-      ::Interface::PortEntity.new(name).tap { |port| yield(port) }
+      ::Interface::PortEntity.new(name).tap { |port| port.instance_eval(&block) }
     end
   end
 end

data/lib/interface/port_entity.rb

@@ -2,7 +2,8 @@ module Interface
   # TODO
   # => define Schemas with dry-validation
   class PortEntity < Struct.new(:name)
-    WTFError = Class.new(StandardError)
+    WTFError          = Class.new(StandardError)
+    InvalidInputError = Class.new(StandardError)
 
     N_A = 'N/A'.freeze
     LIM = ('-' * 48).freeze
@@ -11,16 +12,27 @@ module Interface
       @description = text
     end
 
-    def call
-      if @implementation.nil?
-        fail(WTFError.new("WAT A HECK U DOIN'! THERE'S NO IMPLEMENTATION TO CALL!"))
+    def call(*args, &block)
+      if @handler.nil?
+        fail(WTFError.new("WAT A HECK U DOIN'! THERE'S NO HANDLER TO CALL!"))
       end
 
-      @implementation.call
+      if !@contract.nil?
+        fail(InvalidInputError.new("Empty argument list doesn not comply with the Contract")) if args.empty?
+
+        errors = @contract.call(*args).errors
+        fail(InvalidInputError.new(errors)) if errors.any?
+      end
+
+      @handler.call(*args, &block)
+    end
+
+    def handler(klass)
+      @handler = klass
     end
 
-    def implementation(klass)
-      @implementation = klass
+    def contract(validation_schema)
+      @contract = validation_schema
     end
 
     def returns(hash)
@@ -38,7 +50,7 @@ module Interface
 #{LIM}
 Name:\t#{ name }
 Desc:\t#{        @description    || N_A}
-Responsible:\t#{ @implementation || N_A}
+Responsible:\t#{ @handler || N_A}
 Accepts:\t#{     @arguments      || N_A}
 Returns:
 \tsuccess:\t#{   @returns && @returns.fetch(:success, N_A) || N_A }

data/lib/interface.rb

@@ -1,4 +1,5 @@
 require 'dry-configurable'
+require 'dry-validation'
 require 'factorymethods'
 
 module Interface

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: interface-dsl
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Oleksiy Kurnenkov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-03 00:00:00.000000000 Z
+date: 2017-01-06 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-validation
+  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: hashie
   requirement: !ruby/object:Gem::Requirement