evt-template_method 2.0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7df86eec2be2b5378f682b6c8b32b5f80c41d20b28ce0f99559e5c584d047b68
+  data.tar.gz: bdc177a975ef3948d23d1593247066c3e5bcaefbc52ab482333ffa62b77e9e65
+SHA512:
+  metadata.gz: 3f29692f4c50d16bcbaeb1d717ad40a578be5506281d99e462efc3902e52482ae6fa2230022778288b803a0d92da8ae2d07363c49680af7cf94705f4b0b34070
+  data.tar.gz: 9cdee8a69ff9a491c3de205413911fd0803670dd5018177fda206fc479bc487e891eca785cf9f04ad70a30e65230842403e5824f08e9b7d3df40ca8776cad8df

data/lib/template_method/activate.rb

@@ -0,0 +1,31 @@
+module TemplateMethod
+  def self.activate(target_class=nil)
+    target_class ||= Object
+
+    return if target_class.ancestors.include?(TemplateMethod::Macro)
+
+    target_class.extend(TemplateMethod::Macro)
+  end
+
+  def self.activated?(target_class=nil)
+    target_class ||= Object
+
+    subject = subject_class(target_class)
+
+    Macro.macro_methods.each do |mthd|
+      if not subject.respond_to?(mthd)
+        return false
+      end
+    end
+
+    true
+  end
+
+  def self.subject_class(subject)
+    if [Module, Class].include?(subject)
+      return subject
+    else
+      return subject.class
+    end
+  end
+end

data/lib/template_method/controls/clean.rb

@@ -0,0 +1,12 @@
+module TemplateMethod
+  module Controls
+    module Clean
+      class Example
+      end
+
+      def self.example
+        Example.new
+      end
+    end
+  end
+end

data/lib/template_method/controls/extended.rb

@@ -0,0 +1,14 @@
+module TemplateMethod
+  module Controls
+    module Extended
+      def self.example
+        Example.new
+      end
+
+      class Example
+        extend ::TemplateMethod
+      end
+    end
+  end
+end
+

data/lib/template_method/controls/included.rb

@@ -0,0 +1,13 @@
+module TemplateMethod
+  module Controls
+    module Included
+      def self.example
+        Example.new
+      end
+
+      class Example
+        include ::TemplateMethod
+      end
+    end
+  end
+end

data/lib/template_method/controls/template_method.rb

@@ -0,0 +1,101 @@
+module TemplateMethod
+  module Controls
+    module TemplateMethod
+      def self.example
+        Example.new
+      end
+
+      class Example
+        include ::TemplateMethod
+        template_method :some_method
+      end
+
+      module Body
+        def self.example
+          Example.new
+        end
+
+        class Example
+          include ::TemplateMethod
+          template_method :some_method do |*|
+            :something
+          end
+        end
+      end
+
+      module Implemented
+        def self.example
+          Example.new
+        end
+
+        class Example
+          include ::TemplateMethod
+          template_method :some_method
+
+          def some_method
+            "some concrete result"
+          end
+        end
+
+        module AlreadyImplemented
+          def self.example
+            Example.new
+          end
+
+          class Example
+            def some_method
+              "some concrete result"
+            end
+
+            include ::TemplateMethod
+            template_method :some_method
+          end
+        end
+
+        module Module
+          def self.example
+            Example.new
+          end
+
+          class Example
+            include ::TemplateMethod
+            template_method :some_method
+
+            module SomeModule
+              def some_method
+                "some module concrete result"
+              end
+            end
+            include SomeModule
+          end
+        end
+      end
+
+      module Variant
+        def self.example
+          Example.new
+        end
+
+        class Example
+          include ::TemplateMethod
+          template_method! :some_method
+
+          def some_method
+            'some concrete result'
+          end
+        end
+
+        module NotImplemented
+          def self.example
+            Example.new
+          end
+
+          class Example
+            include ::TemplateMethod
+            template_method! :some_method
+          end
+        end
+      end
+    end
+  end
+end

data/lib/template_method/controls.rb

@@ -0,0 +1,4 @@
+require 'template_method/controls/template_method'
+require 'template_method/controls/clean'
+require 'template_method/controls/extended'
+require 'template_method/controls/included'

data/lib/template_method/error.rb

@@ -0,0 +1,3 @@
+module TemplateMethod
+  Error = Class.new(RuntimeError)
+end

data/lib/template_method/macro.rb

@@ -0,0 +1,40 @@
+module TemplateMethod
+  module Macro
+    def template_method_module
+      @template_method_module ||= include_template_method_module
+    end
+
+    def include_template_method_module
+      mod = Module.new
+      include mod
+      mod
+    end
+
+    def template_method_macro(method_name, &implementation)
+      implementation ||= proc { |*| nil }
+
+      inherit = true
+      concrete_implementation_exists = method_defined?(method_name, inherit)
+      if concrete_implementation_exists
+        return
+      end
+
+      template_method_module.define_method(method_name, &implementation)
+    end
+    alias :template_method :template_method_macro
+
+    def template_method_variant_macro(method_name)
+      template_method_macro(method_name) do
+        raise TemplateMethod::Error, "Implementation is required (Method name: #{method_name})"
+      end
+    end
+    alias :template_method! :template_method_variant_macro
+
+    def self.macro_methods
+      [
+        'template_method',
+        'template_method!'
+      ]
+    end
+  end
+end

data/lib/template_method/template_method.rb

@@ -0,0 +1,9 @@
+module TemplateMethod
+  def self.included(cls)
+    activate(cls)
+  end
+
+  def self.extended(cls)
+    activate(cls)
+  end
+end

data/lib/template_method.rb

@@ -0,0 +1,4 @@
+require 'template_method/error'
+require 'template_method/macro'
+require 'template_method/activate'
+require 'template_method/template_method'

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: evt-template_method
+version: !ruby/object:Gem::Version
+  version: 2.0.0.0
+platform: ruby
+authors:
+- The Eventide Project
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-03-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: test_bench
+  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: opensource@eventide-project.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/template_method.rb
+- lib/template_method/activate.rb
+- lib/template_method/controls.rb
+- lib/template_method/controls/clean.rb
+- lib/template_method/controls/extended.rb
+- lib/template_method/controls/included.rb
+- lib/template_method/controls/template_method.rb
+- lib/template_method/error.rb
+- lib/template_method/macro.rb
+- lib/template_method/template_method.rb
+homepage: https://github.com/eventide-project/template-method
+licenses:
+- MIT
+metadata: {}
+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.6
+signing_key:
+specification_version: 4
+summary: Template method declaration
+test_files: []