solid-adapters 1.0.0

data/examples/ports_and_adapters/db/setup.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'active_support/all'
+
+ActiveRecord::Base.establish_connection(
+  host: 'localhost',
+  adapter: 'sqlite3',
+  database: ':memory:'
+)
+
+ActiveRecord::Schema.define do
+  create_table :users do |t|
+    t.column :name, :string
+    t.column :email, :string
+  end
+end

data/examples/ports_and_adapters/lib/user/creation.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module User
+  class Creation
+    def initialize(repository:)
+      repository => Repository
+
+      @repository = repository
+    end
+
+    def call(name:, email:)
+      user_data = @repository.create(name:, email:)
+
+      puts "Created user: #{user_data.inspect}"
+
+      user_data
+    end
+  end
+end

data/examples/ports_and_adapters/lib/user/data.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module User
+  Data = ::Struct.new(:id, :name, :email, keyword_init: true)
+end

data/examples/ports_and_adapters/lib/user/repository.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module User::Repository
+  include Solid::Adapters::Interface
+
+  module Methods
+    def create(name:, email:)
+      name => String
+      email => String
+
+      super.tap { _1 => ::User::Data[id: Integer, name: String, email: String] }
+    end
+  end
+end

data/examples/ports_and_adapters/test/user_test/repository.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module UserTest
+  class Repository
+    include ::User::Repository
+
+    attr_reader :records
+
+    def initialize
+      @records = []
+    end
+
+    def create(name:, email:)
+      id = @records.size + 1
+
+      @records[id] = { id:, name:, email: }
+
+      ::User::Data.new(id:, name:, email:)
+    end
+  end
+end

data/lib/solid/adapters/configurable/options.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+class Solid::Adapters::Configurable::Options
+  MapOption = ->(key) { key.end_with?("=") ? key[0..-2].to_sym : key }
+  MapValue = ->(value) { value.is_a?(::Proc) ? value.call : value }
+
+  def initialize(**options)
+    @options = options
+  end
+
+  def to_h
+    @options.dup
+  end
+
+  def key?(name)
+    @options.key?(name)
+  end
+
+  def [](name)
+    @options[name].then(&MapValue)
+  end
+
+  def fetch(name, &block)
+    @options.fetch(name, &block).then(&MapValue)
+  end
+
+  def method_missing(method_name, value = nil, &block)
+    return fetch(method_name) { super } if !method_name.end_with?("=") && !block
+
+    option_name = MapOption[method_name]
+
+    @options[option_name] = block || value
+  end
+
+  def respond_to_missing?(method_name, include_private = false)
+    (method_name.end_with?("=") || key?(method_name)) || super
+  end
+
+  def freeze
+    @options.freeze
+
+    super
+  end
+end

data/lib/solid/adapters/configurable.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Solid::Adapters
+  module Configurable
+    require_relative "configurable/options"
+
+    def config
+      @config ||= Options.new
+    end
+
+    def configuration(freeze: true)
+      yield(config)
+
+      config.tap { _1.freeze if freeze }
+    end
+
+    alias_method :configure, :configuration
+  end
+end

data/lib/solid/adapters/core/config.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Solid::Adapters::Core
+  class Config
+    attr_accessor :proxy_enabled, :interface_enabled
+
+    def initialize(proxy_enabled: true, interface_enabled: true)
+      self.proxy_enabled = proxy_enabled
+      self.interface_enabled = interface_enabled
+    end
+
+    def proxy_enabled?
+      proxy_enabled
+    end
+
+    def interface_enabled?
+      interface_enabled
+    end
+
+    def options
+      {
+        proxy_enabled: proxy_enabled,
+        interface_enabled: interface_enabled
+      }
+    end
+
+    def inspect
+      "#<#{self.class.name} proxy_enabled=#{proxy_enabled}, interface_enabled=#{interface_enabled}>"
+    end
+
+    @instance = new
+
+    singleton_class.send(:attr_reader, :instance)
+  end
+end

data/lib/solid/adapters/core/proxy.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Solid::Adapters::Core
+  module Proxy
+    module ClassMethods
+      def [](object)
+        new(object)
+      end
+
+      def to_proc
+        ->(object) { new(object) }
+      end
+    end
+
+    class Base
+      extend ClassMethods
+
+      attr_reader :object
+
+      def initialize(object)
+        @object = object
+      end
+    end
+  end
+end

data/lib/solid/adapters/interface.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require "delegate"
+
+module Solid::Adapters
+  module Interface
+    module Callbacks
+      def extended(impl)
+        impl.singleton_class.prepend(self::Methods)
+      end
+
+      def included(impl)
+        impl.prepend(self::Methods)
+      end
+    end
+
+    module ClassMethods
+      def [](object)
+        const_get(:Proxy, false).new(object).extend(self)
+      end
+    end
+
+    module ProxyDisabled
+      extend Core::Proxy::ClassMethods
+
+      def self.new(object)
+        object
+      end
+    end
+
+    DEFINE = lambda do |interface, enabled:|
+      proxy = ProxyDisabled
+
+      if enabled
+        proxy = ::Class.new(::SimpleDelegator)
+        proxy.extend(Core::Proxy::ClassMethods)
+
+        interface.extend(Callbacks)
+      end
+
+      interface.const_set(:Proxy, proxy)
+      interface.extend(ClassMethods)
+    end
+
+    def self.included(interface)
+      DEFINE[interface, enabled: Core::Config.instance.interface_enabled]
+    end
+
+    module AlwaysEnabled
+      def self.included(interface)
+        DEFINE[interface, enabled: true]
+      end
+    end
+
+    private_constant :Callbacks, :ClassMethods, :ProxyDisabled, :DEFINE
+  end
+end

data/lib/solid/adapters/proxy.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Solid::Adapters
+  class Proxy < Core::Proxy::Base
+    AlwaysEnabled = ::Class.new(Core::Proxy::Base)
+
+    def self.new(object)
+      Core::Config.instance.proxy_enabled ? super : object
+    end
+  end
+end

data/lib/solid/adapters/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Solid
+  module Adapters
+    VERSION = "1.0.0"
+  end
+end

data/lib/solid/adapters.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative "adapters/version"
+
+module Solid
+  module Adapters
+    module Core
+      require_relative "adapters/core/config"
+      require_relative "adapters/core/proxy"
+    end
+
+    require_relative "adapters/configurable"
+    require_relative "adapters/interface"
+    require_relative "adapters/proxy"
+
+    def self.config
+      Core::Config.instance
+    end
+
+    def self.configuration(freeze: true)
+      yield(config)
+
+      config.tap { _1.freeze if freeze }
+    end
+
+    singleton_class.send(:alias_method, :configure, :configuration)
+  end
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: solid-adapters
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Rodrigo Serradura
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-06-24 00:00:00.000000000 Z
+dependencies: []
+description: Write interface contracts using pure Ruby.
+email:
+- rodrigo.serradura@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- ".standard.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- examples/README.md
+- examples/anti_corruption_layer/README.md
+- examples/anti_corruption_layer/Rakefile
+- examples/anti_corruption_layer/app/models/payment/charge_credit_card.rb
+- examples/anti_corruption_layer/config.rb
+- examples/anti_corruption_layer/lib/payment_gateways.rb
+- examples/anti_corruption_layer/lib/payment_gateways/adapters/circle_up.rb
+- examples/anti_corruption_layer/lib/payment_gateways/adapters/pay_friend.rb
+- examples/anti_corruption_layer/lib/payment_gateways/contract.rb
+- examples/anti_corruption_layer/lib/payment_gateways/response.rb
+- examples/anti_corruption_layer/vendor/circle_up/client.rb
+- examples/anti_corruption_layer/vendor/pay_friend/client.rb
+- examples/ports_and_adapters/README.md
+- examples/ports_and_adapters/Rakefile
+- examples/ports_and_adapters/app/models/user/record.rb
+- examples/ports_and_adapters/app/models/user/record/repository.rb
+- examples/ports_and_adapters/config.rb
+- examples/ports_and_adapters/db/setup.rb
+- examples/ports_and_adapters/lib/user/creation.rb
+- examples/ports_and_adapters/lib/user/data.rb
+- examples/ports_and_adapters/lib/user/repository.rb
+- examples/ports_and_adapters/test/user_test/repository.rb
+- lib/solid/adapters.rb
+- lib/solid/adapters/configurable.rb
+- lib/solid/adapters/configurable/options.rb
+- lib/solid/adapters/core/config.rb
+- lib/solid/adapters/core/proxy.rb
+- lib/solid/adapters/interface.rb
+- lib/solid/adapters/proxy.rb
+- lib/solid/adapters/version.rb
+homepage: https://github.com/serradura/solid-adapters
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/serradura/solid-adapters
+  source_code_uri: https://github.com/serradura/solid-adapters
+  changelog_uri: https://github.com/solid-process/solid-adapters/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.14
+signing_key:
+specification_version: 4
+summary: Write interface contracts using pure Ruby.
+test_files: []