interface-dsl 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e070b39851cc80259b202cd24b845d623387c7ac
+  data.tar.gz: 897432bcb7838f0fe391f4b2a2559fa6541c3871
+SHA512:
+  metadata.gz: 538e69567615952afefb27d59a2ac9825685813d267eac13e4df1a8c39184b200b2c44bfb3f75ef548cbee69db8d6250db261561ef212b09572a5935000261f3
+  data.tar.gz: 490ab14c0b3fc4e8112b5a1a24044b8b86c7c08526fc288f7877b489c22d64435dcbb6be43689092c72c521a0cd6a4066fdf89c4351a2248da6fa6dc12676fbd

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+TODO
+/*.gem

data/.rspec

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

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in interface-dsl.gemspec
+gemspec
+
+gem 'factorymethods'
+gem 'hashie'

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Oleksiy Kurnenkov
+
+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,88 @@
+# Interface::Dsl
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'interface-dsl'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install interface-dsl
+
+## Usage
+
+```ruby
+# Define an operation class
+class MidnightCodingOperation
+  # Define :call factory method conveniently
+  extend FactoryMethods
+
+  deffactory :call
+
+  # Or do it manually
+  # def self.call(*args)
+  #   new(*args).call
+  # end
+
+  # Implement some logic
+  def call
+    puts "Step 1: turn off the light o.o"
+    puts "Step 2: git add ."
+    puts "Step 3: git commit -m 'asta la vista... (c)'"
+    puts "Step 4: git push --force origin master"
+    puts "Step 5: fall asleep -.-"
+  end
+end
+
+# Define a facade API class
+class CodeMonkeyAPI
+  # Enable DSL
+  extend Interface::DSL
+
+  # Define some interface
+  interface(:midnight_api) do |api|
+
+    # Define some endpoint
+    api.defpoint(:emergency_push) do |op|
+      op.describe "Push the code, fall asleep"
+      op.implementation MidnightCodingOperation
+    end
+  end
+end
+
+# Activate your operation:
+CodeMonkeyAPI.midnight_api.emergency_push.call
+#
+# => Step 1: turn off the light o.o
+# => Step 2: git add .
+# => Step 3: git commit -m 'asta la vista... (c)'
+# => Step 4: git push --force origin master
+# => Step 5: fall asleep -.-
+#
+# Easy :)
+```
+
+## Organize your APIs to honour the Law of Demeter
+```ruby
+CodeMonkeyAPI                                 # top-level API
+MidnightCoderAPI = CodeMonkeyAPI.midnight_api # specific API
+MidnightCoderAPI.emergency_push.call          # usage
+```
+
+## 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/o-kurnenkov/interface-dsl.
+

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 "interface/dsl"
+
+# 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/interface-dsl.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'interface/dsl/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "interface-dsl"
+  spec.version       = Interface::Dsl::VERSION
+  spec.authors       = ["Oleksiy Kurnenkov"]
+  spec.email         = ["oleksiy.kurnenkov@onapp.com"]
+  spec.licenses      = ['MIT']
+  spec.summary       = %q{Interface description DSL}
+  spec.description   = %q{Make your Interfaces declarative!}
+  spec.homepage      = "https://github.com/o-kurnenkov/interface-dsl"
+
+  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 'hashie', '~> 3.4'
+  spec.add_runtime_dependency 'dry-configurable', '~> 0.5'
+  spec.add_runtime_dependency 'factorymethods', '~> 1.0'
+
+  spec.add_development_dependency 'factorymethods', '~> 1.0'
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/interface/adapter.rb

@@ -0,0 +1,35 @@
+module Interface
+  class Adapter
+    CallingError   = Class.new(StandardError)
+    InterfaceError = Class.new(StandardError)
+
+    extend FactoryMethods
+
+    def_factory :call
+
+    def initialize(callable)
+      @callable = callable
+    end
+
+    def call
+      unless callable.respond_to?(:call)
+        fail(InterfaceError("#{callable.class} is not callable!"))
+      end
+
+      _call
+    end
+
+    private
+
+    def _call
+      result = callable.call
+      if result.is_a?(Array)
+        status, _result = result
+        status == :ok || fail(ServiceError("Error while calling #{callable.class}: #{_result}"))
+        _result
+      else
+        result
+      end
+    end
+  end
+end

data/lib/interface/dsl/version.rb

@@ -0,0 +1,5 @@
+module Interface
+  module Dsl
+    VERSION = "0.1.1"
+  end
+end

data/lib/interface/dsl.rb

@@ -0,0 +1,95 @@
+require "interface"
+require "interface/dsl/version"
+
+module Interface
+  module DSL
+    OrphanPort         = Class.new(StandardError)
+    ImmutableInterface = Class.new(StandardError)
+
+    require "interface/port_group"
+    require "interface/port_entity"
+
+    def interface(name, &block)
+      if interfaces.key?(name)
+        fail(ImmutableInterface.new("Interface can't be redefined or reopened! Use .extend_api method"))
+      end
+
+      interfaces.merge!(name => ::Interface::PortGroup.new(name, self).tap do |group|
+        yield(group)
+      end)
+    end
+
+    def defpoint(name, &block)
+      check_top_level_enpoint_policy
+
+      points.merge!(name => define_entity(name, &block))
+    end
+
+    def method_missing(meth, *args, &block)
+      super unless respond_to?(:interfaces) || respond_to?(:points)
+
+      if interfaces.respond_to?(meth)
+        interfaces.send(meth)
+      elsif points.respond_to?(meth)
+        points.send(meth)
+      else
+        super
+      end
+    end
+
+    # extend_api(as: 'northbound.operations.truck_load', with_class: TruckLoadAPI)
+    def extend_api(as: , with_class: )
+      # Maybe Define just a nested interface???
+      _merge_point = respond_to?(:points) ? points : self
+
+      _merge_point.merge!(as => with_class)
+    end
+
+    def doc
+      _name = self.respond_to?(:name) ? self.name : self.class.name
+      puts _name
+      doc_all_endpoints
+      interfaces.each_pair { |_, i| i.doc }
+    end
+
+    def interfaces
+      @interfaces ||= Hashie::Mash.new
+    end
+
+    def points
+      @points ||= Hashie::Mash.new
+    end
+
+    private
+
+    def check_top_level_enpoint_policy
+      return if Interface.config.allow_top_level_api_endpoints? || !top_level?
+
+      fail(OrphanPort.new("Can not be defined as a top level Interface"))
+    end
+
+    def top_level?
+      if respond_to?(:parent)
+        parent.nil? && interfaces.empty?
+      else
+        interfaces.empty?
+      end
+    end
+
+    def doc_all_endpoints
+      traverse_all(points, print_doc)
+    end
+
+    def traverse_all(collection, execute_block)
+      collection.each_pair { |name, i| execute_block.call(i) }
+    end
+
+    def print_doc
+      @print_doc ||= ->(i) { i.doc }
+    end
+
+    def define_entity(name, &block)
+      ::Interface::PortEntity.new(name).tap { |port| yield(port) }
+    end
+  end
+end

data/lib/interface/port_entity.rb

@@ -0,0 +1,50 @@
+module Interface
+  # TODO
+  # => define Schemas with dry-validation
+  class PortEntity < Struct.new(:name)
+    WTFError = Class.new(StandardError)
+
+    N_A = 'N/A'.freeze
+    LIM = ('-' * 48).freeze
+
+    def describe(text)
+      @description = text
+    end
+
+    def call
+      if @implementation.nil?
+        fail(WTFError.new("WAT A HECK U DOIN'! THERE'S NO IMPLEMENTATION TO CALL!"))
+      end
+
+      @implementation.call
+    end
+
+    def implementation(klass)
+      @implementation = klass
+    end
+
+    def returns(hash)
+      { success: [:ok,    Object],
+        failure: [:error, String] }
+    end
+
+    #TODO
+    def before_call; end
+    def after_call; end
+    def wrap_call; end
+
+    def doc
+      puts <<-DOC
+#{LIM}
+Name:\t#{ name }
+Desc:\t#{        @description    || N_A}
+Responsible:\t#{ @implementation || N_A}
+Accepts:\t#{     @arguments      || N_A}
+Returns:
+\tsuccess:\t#{   @returns && @returns.fetch(:success, N_A) || N_A }
+\tfailure:\t#{   @returns && @returns.fetch(:failure, N_A) || N_A }
+#{LIM}
+      DOC
+    end
+  end
+end

data/lib/interface/port_group.rb

@@ -0,0 +1,14 @@
+require 'hashie'
+
+module Interface
+  class PortGroup
+    include ::Interface::DSL
+
+    attr_reader :name, :parent
+
+    def initialize(name, parent = nil)
+      @name = name
+      @parent = parent
+    end
+  end
+end

data/lib/interface.rb

@@ -0,0 +1,8 @@
+require 'dry-configurable'
+require 'factorymethods'
+
+module Interface
+  extend ::Dry::Configurable
+
+  setting(:allow_top_level_api_endpoints?, false)
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: interface-dsl
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Oleksiy Kurnenkov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-01-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: dry-configurable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: factorymethods
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: factorymethods
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Make your Interfaces declarative!
+email:
+- oleksiy.kurnenkov@onapp.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- interface-dsl.gemspec
+- lib/interface.rb
+- lib/interface/adapter.rb
+- lib/interface/dsl.rb
+- lib/interface/dsl/version.rb
+- lib/interface/port_entity.rb
+- lib/interface/port_group.rb
+homepage: https://github.com/o-kurnenkov/interface-dsl
+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.1
+signing_key: 
+specification_version: 4
+summary: Interface description DSL
+test_files: []