evt-transform 0.1.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0eb5f9cee74f7a41101a61f683318734da02d87e
+  data.tar.gz: ebae2488a51203863f88c4d2b879e6b13089e418
+SHA512:
+  metadata.gz: 1ae466e13cfdfac031f55ffddfdea634c92a1e58ea031f09df904934e8203a5a9f4484fa3136ca2338dd60ed832adc152177029587d027eebd73ddad28e84586
+  data.tar.gz: 4d41b452e432ec11ac0d0e15df4b64f9173b7a7582bcc9ee729650b8a6d56dc436cc3a3e4a7d9aa7d4e16db480dbb537664054300110710d61f208a93fa5233f

data/lib/transform.rb

@@ -0,0 +1,6 @@
+require 'log'
+
+require 'transform/log'
+require 'transform/transform'
+require 'transform/write'
+require 'transform/read'

data/lib/transform/controls.rb

@@ -0,0 +1,8 @@
+require 'transform/controls/text'
+require 'transform/controls/raw_data'
+require 'transform/controls/subject'
+require 'transform/controls/subject_instance_receives_class'
+require 'transform/controls/no_transform'
+require 'transform/controls/no_transform_methods'
+require 'transform/controls/no_format'
+require 'transform/controls/no_format_methods'

data/lib/transform/controls/no_format.rb

@@ -0,0 +1,26 @@
+module Transform
+  module Controls
+    module NoFormat
+      class Example
+        module Transformer
+          def self.some_format
+          end
+
+          def self.instance(raw_data)
+          end
+
+          def self.raw_data(instance)
+          end
+        end
+      end
+
+      def self.example
+        Example.new
+      end
+
+      def self.example_class
+        Example
+      end
+    end
+  end
+end

data/lib/transform/controls/no_format_methods.rb

@@ -0,0 +1,30 @@
+module Transform
+  module Controls
+    module NoFormatMethods
+      class Example
+        module Transformer
+          def self.some_format
+            SomeFormat
+          end
+
+          def self.instance(raw_data)
+          end
+
+          def self.raw_data(instance)
+          end
+
+          module SomeFormat
+          end
+        end
+      end
+
+      def self.example
+        Example.new
+      end
+
+      def self.example_class
+        Example
+      end
+    end
+  end
+end

data/lib/transform/controls/no_transform.rb

@@ -0,0 +1,16 @@
+module Transform
+  module Controls
+    module NoTransformer
+      class Example
+      end
+
+      def self.example
+        Example.new
+      end
+
+      def self.example_class
+        Example
+      end
+    end
+  end
+end

data/lib/transform/controls/no_transform_methods.rb

@@ -0,0 +1,18 @@
+module Transform
+  module Controls
+    module NoTransformMethods
+      class Example
+        module Transformer
+        end
+      end
+
+      def self.example
+        Example.new
+      end
+
+      def self.example_class
+        Example
+      end
+    end
+  end
+end

data/lib/transform/controls/raw_data.rb

@@ -0,0 +1,9 @@
+module Transform
+  module Controls
+    module RawData
+      def self.example
+        'some raw data'
+      end
+    end
+  end
+end

data/lib/transform/controls/subject.rb

@@ -0,0 +1,49 @@
+module Transform
+  module Controls
+    module Subject
+      def self.example
+        instance = example_class.new
+        instance.some_attribute = Controls::RawData.example
+        instance
+      end
+
+      def self.example_class
+        Example
+      end
+
+      class Example
+        attr_accessor :some_attribute
+
+        def ==(other)
+          other.some_attribute == self.some_attribute
+        end
+
+        module Transformer
+          def self.some_format
+            SomeFormat
+          end
+
+          def self.instance(raw_data)
+            instance = Example.new
+            instance.some_attribute = raw_data
+            instance
+          end
+
+          def self.raw_data(instance)
+            instance.some_attribute
+          end
+
+          module SomeFormat
+            def self.write(raw_data)
+              Controls::Text.example
+            end
+
+            def self.read(text)
+              Controls::RawData.example
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/transform/controls/subject_instance_receives_class.rb

@@ -0,0 +1,37 @@
+module Transform
+  module Controls
+    module Subject
+      module InstanceReceivesClass
+        def self.example
+          instance = example_class.new
+          instance.some_attribute = Controls::RawData.example
+          instance
+        end
+
+        def self.example_class
+          Example
+        end
+
+        class Example
+          attr_accessor :some_attribute
+
+          module Transformer
+            def self.some_format
+              SomeFormat
+            end
+
+            def self.instance(raw_data, cls)
+              Struct.new(:raw_data, :cls).new(raw_data, cls)
+            end
+
+            module SomeFormat
+              def self.read(text)
+                text
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/transform/controls/text.rb

@@ -0,0 +1,9 @@
+module Transform
+  module Controls
+    module Text
+      def self.example
+        'some text'
+      end
+    end
+  end
+end

data/lib/transform/log.rb

@@ -0,0 +1,9 @@
+module Transform
+  class Log < ::Log
+    def tag!(tags)
+      tags << :transform
+      tags << :library
+      tags << :verbose
+    end
+  end
+end

data/lib/transform/read.rb

@@ -0,0 +1,61 @@
+module Transform
+  module Read
+    extend Transform
+
+    def self.mode
+      :read
+    end
+
+    def self.intermediate
+      :instance
+    end
+
+    def self.call(raw_data, format_name, cls)
+      if format_name.instance_of?(Class) && cls.instance_of?(Symbol)
+        cls, format_name = format_name, cls
+      end
+
+      logger.trace { "Reading (Format Name: #{format_name.inspect})" }
+      logger.trace(tags: [:data, :raw_data]) { raw_data.pretty_inspect }
+
+      format = format(cls, format_name)
+
+      assure_mode(format, mode)
+      raw_data = format.read raw_data
+
+      transformed = instance(raw_data, cls)
+
+      logger.info { "Read (Format Name: #{format_name.inspect})" }
+      logger.debug(tags: [:data, :transformed]) { transformed.pretty_inspect }
+
+      transformed
+    end
+
+    def self.instance(raw_data, cls)
+      logger.trace { "Transforming raw data to instance" }
+      logger.trace(tags: [:data, :raw_data]) { raw_data.pretty_inspect }
+
+      transformer = transformer(cls)
+      assure_mode(transformer, intermediate)
+
+      method = transformer.method(:instance)
+
+      instance = nil
+      case method.parameters.length
+      when 1
+        instance = transformer.instance(raw_data)
+      when 2
+        instance = transformer.instance(raw_data, cls)
+      end
+
+      logger.debug { "Transformed raw data to instance" }
+      logger.debug(tags: [:data, :instance]) { instance.pretty_inspect }
+
+      instance
+    end
+
+    def self.logger
+      @logger ||= Log.get(self)
+    end
+  end
+end

data/lib/transform/transform.rb

@@ -0,0 +1,105 @@
+module Transform
+  extend self
+
+  class Error < RuntimeError; end
+
+  def format(subject, format_name)
+    transformer = transformer(subject)
+
+    assure_format(format_name, transformer)
+    get_format(format_name, transformer)
+  end
+
+  def get_format(format_name, transformer)
+    transformer.send(format_name)
+  end
+
+  def transformer(subject)
+    subject_const = subject_const(subject)
+
+    assure_transformer(subject_const)
+    get_transformer(subject_const)
+  end
+
+  def get_transformer(subject_const)
+    subject_const.const_get(:Transformer)
+  end
+
+  def subject_const(subject)
+    [Module, Class].include?(subject.class) ? subject : subject.class
+  end
+
+  def assure_transformer(subject_const)
+    unless transformer_const?(subject_const)
+      raise Error, "#{subject_const.name} doesn't have a `Transformer' namespace"
+    end
+  end
+
+  def transformer?(subject)
+    subject_const = subject_const(subject)
+    transformer_const?(subject_const)
+  end
+
+  def transformer_const?(subject_const)
+    subject_const.const_defined?(:Transformer)
+  end
+
+  def assure_format(format_name, transformer)
+    unless format_accessor?(format_name, transformer)
+      raise Error, "#{transformer.name} does not implement `#{format_name}'"
+    end
+  end
+
+  def format_accessor?(format_name, transformer)
+    transformer.respond_to?(format_name)
+  end
+
+  def format?(format_name, transformer)
+    format = get_format(format_name, transformer)
+    !!format
+  end
+
+  def assure_mode(format, mode)
+    unless mode?(format, mode)
+      raise Error, "#{format.name} does not implement `#{mode}'"
+    end
+  end
+
+  def mode?(format, mode)
+    format.respond_to?(mode)
+  end
+
+  def intermediate?(transformer, intermediate_name)
+    transformer.respond_to?(intermediate_name)
+  end
+
+  def implemented?(subject, format_name)
+    subject_const = subject_const(subject)
+
+    unless transformer_const?(subject_const)
+      return false
+    end
+
+    transformer = get_transformer(subject_const)
+
+    unless intermediate?(transformer, intermediate)
+      return false
+    end
+
+    unless format_accessor?(format_name, transformer)
+      return false
+    end
+
+    unless format?(format_name, transformer)
+      return false
+    end
+
+    format = get_format(format_name, transformer)
+
+    unless mode?(format, mode)
+      return false
+    end
+
+    true
+  end
+end

data/lib/transform/write.rb

@@ -0,0 +1,50 @@
+module Transform
+  module Write
+    extend Transform
+
+    def self.mode
+      :write
+    end
+
+    def self.intermediate
+      :raw_data
+    end
+
+    def self.call(instance, format_name)
+      logger.trace { "Writing (Format Name: #{format_name.inspect})" }
+      logger.trace(tags: [:data, :instance]) { instance.pretty_inspect }
+
+      format = format(instance, format_name)
+
+      raw_data = raw_data(instance)
+
+      assure_mode(format, mode)
+
+      transformed = format.write(raw_data)
+
+      logger.info { "Wrote (Format Name: #{format_name.inspect})" }
+      logger.debug(tags: [:data, :transformed]) { transformed.pretty_inspect }
+
+      transformed
+    end
+
+    def self.raw_data(instance)
+      logger.trace { "Transforming instance to raw data" }
+      logger.trace(tags: [:data, :instance]) { instance.pretty_inspect }
+
+      transformer = transformer(instance)
+      assure_mode(transformer, intermediate)
+
+      raw_data = transformer.raw_data(instance)
+
+      logger.debug { "Transformed to raw data" }
+      logger.debug(tags: [:data, :raw_data]) { raw_data.pretty_inspect }
+
+      raw_data
+    end
+
+    def self.logger
+      @logger ||= Log.get(self)
+    end
+  end
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: evt-transform
+version: !ruby/object:Gem::Version
+  version: 0.1.1.3
+platform: ruby
+authors:
+- The Eventide Project
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: evt-log
+  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: ntl-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/transform.rb
+- lib/transform/controls.rb
+- lib/transform/controls/no_format.rb
+- lib/transform/controls/no_format_methods.rb
+- lib/transform/controls/no_transform.rb
+- lib/transform/controls/no_transform_methods.rb
+- lib/transform/controls/raw_data.rb
+- lib/transform/controls/subject.rb
+- lib/transform/controls/subject_instance_receives_class.rb
+- lib/transform/controls/text.rb
+- lib/transform/log.rb
+- lib/transform/read.rb
+- lib/transform/transform.rb
+- lib/transform/write.rb
+homepage: https://github.com/eventide-project/transform
+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.3.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Common interface for object and format transformation, and transformer discovery
+test_files: []