taksi 0.2.1 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c176b6593b9e570169fa5ec6103bfd635c8bae751342ce7b8c986ec3fa43df3d
-  data.tar.gz: e84fe608e7b15263084b9f3f745eba7e9cf47d8460ecb02032ad930fe85e1c14
+  metadata.gz: 2bf8909dd9e8de12aa8fe7a7f93fcf3a414f8c8bc850bea7ff032bfcfd150d3e
+  data.tar.gz: 02ac2b0dccafc25969a9fc861a88bbaba468b932c014fe898c14e31f42db177d
 SHA512:
-  metadata.gz: b6b421c3efe426c48c934ccfc9ba2ae385a74fd97cc63fc0c4fbca14070f547ab0003d09abc6fe724ea6dd064d8d49d00a08bf268193850337566b945760be7a
-  data.tar.gz: 45fa852395860e6b3ade5d413518d2cca268cefbd9faeb21aa83d269e8c74d5d3d5ed9ba2c7fc27906d9d55222acea5d6f53396f0945ae6e54374704a2c14e05
+  metadata.gz: 38cc7864f7dc6435e1b48d21f9f1d65b5f4d8ebb06c509d1101742d79e494f8b164fe0c133e873fd52f38570da9c21fd20c2e9ee632330a4f6e39777d70d3350
+  data.tar.gz: c9c0521ad137a949a57686e773eb04aedce5cefcf95e0bf79fe4fa05b89c4ef5f921c6596ec25ce6687bdaf7897b4e82372af84378139bbe5f224a14f51767f0

data/README.md

@@ -22,11 +22,13 @@ class Components::Users::ProfileResume
   include Taksi::Component.new('users/profile_resume')
 
   content do
-    name Taksi::Dynamic
+    static :profile_kind, 'resume' # same as `field :profile_kind, Taksi::Static`
 
-    details do
-      age Taksi::Dynamic
-      email Taksi::Dynamic
+    dynamic :name
+
+    field :details do
+      field :age Taksi::Dynamic # same as `dynamic :age`
+      field :email Taksi::Dynamic
     end
   end
 end
@@ -69,8 +71,10 @@ Which provide us:
     {
       "name": "users/profile_resume",
       "identifier": "component$0",
+      "requires_data": true,
       "content": {
         "name": null,
+        "profile_kind": "resume",
         "details": {
           "age": null,
           "email": null

data/lib/taksi/component.rb

@@ -1,6 +1,18 @@
 # frozen_string_literal: true
 
 module Taksi
+  # A custom module to turn a class into a component on taksi protocol
+  #
+  # ```ruby
+  #   class CustomComponent
+  #     include Taksi::Component.new('customs/component_name')
+  #
+  #     content do
+  #       field_name Taksi::Static
+  #     end
+  #   end
+  # ```
+  #
   class Component < ::Module
     attr_reader :identifier
 
@@ -61,7 +73,6 @@ module Taksi
       def load_data_from_key_to_object(data, field, obj)
         splitted_full_path = field.key.to_s.split('.')
         setter_key = splitted_full_path.pop
-        splitted_full_path.shift # remove content root key, as it makes no sense in data object
 
         relative_object = splitted_full_path.reduce(obj) do |memo, path_part|
           memo[path_part.to_sym] ||= {}

data/lib/taksi/components/field.rb

@@ -10,35 +10,45 @@ module Taksi
         @name = name.to_sym
         @parent = parent
 
+        raise <<~MESSAGE unless args.size.positive? || block_given?
+          You must provide a value or a block definition to build field
+        MESSAGE
+
         @value = args.shift.new(skeleton, name, *args) if args.size.positive?
         @nested_fields = []
 
         instance_exec(&block) if block_given?
-        @defined = true
       end
 
       def key
         return name if parent.nil? || parent.root?
 
-        "#{parent.name}.#{name}"
+        "#{parent.key}.#{name}"
       end
 
+      # Fetches the data for in `data` for the current field
+      # @return any
       def fetch_from(data)
-        return value.as_json if value.static?
+        return value.as_json if value&.static?
 
-        return data[name] if parent.nil? || parent.root?
+        return data.fetch(name) if parent.nil? || parent.root?
 
-        parent.fetch_from(data)[name]
-      rescue NoMethodError
-        raise NameError, "Couldn't fetch #{key.inspect} from data: #{data.inspect}"
+        parent.fetch_from(data).fetch(name)
+      rescue ::KeyError
+        raise ::KeyError, "Couldn't fetch #{key.inspect} from data: #{data.inspect}"
       end
 
+      # Turns the field into his json representation
+      # The returned hash is compatible with the skeleton json specification
+      # @return Hash
       def as_json
         return {name => @nested_fields.map(&:as_json).inject({}, &:merge)} if nested?
 
         {name => value.as_json}
       end
 
+      # Builds up a interator over all fields included nested ones
+      # @returns Enumerable
       def fields
         Enumerator.new do |yielder|
           @nested_fields.each do |field|
@@ -59,16 +69,28 @@ module Taksi
         @parent.nil?
       end
 
-      def method_missing(name, *args, &block)
-        return super if @defined
+      def dynamic?
+        return @nested_fields.any?(&:dynamic?) if @value.nil?
+
+        @value.dynamic?
+      end
 
-        @nested_fields << self.class.new(skeleton, name, *args, parent: self, &block)
+      def field(name, *args, &block)
+        self.class.new(skeleton, name, *args, parent: self, &block).tap do |new_field|
+          @nested_fields << new_field
+        end
       end
 
-      def respond_to_missing?(name)
-        return super if @defined
+      def nested(name, &block)
+        field(name, &block)
+      end
+
+      def static(name, value)
+        field(name, ::Taksi::Values::Static, value)
+      end
 
-        true
+      def dynamic(name)
+        field(name, ::Taksi::Values::Dynamic)
       end
     end
   end

data/lib/taksi/components/skeleton.rb

@@ -9,6 +9,8 @@ module Taksi
         @parent = parent
         @name = name
 
+        raise 'To build a component you need to provide a `content` block' unless block_given?
+
         @content = ::Taksi::Components::Field.new(self, :content, &block)
       end
 
@@ -20,10 +22,15 @@ module Taksi
         content.fields
       end
 
+      def dynamic?
+        @content.dynamic?
+      end
+
       def as_json
         {
           name: name,
-          identifier: id
+          identifier: id,
+          requires_data: dynamic?
         }.tap do |json|
           json.merge!(content.as_json)
         end

data/lib/taksi/interface.rb

@@ -1,9 +1,17 @@
 # frozen_string_literal: true
 
 module Taksi
+  # A custom module that turns a class into a interface on taksi protocol
+  #
   class Interface < ::Module
     attr_reader :interface_name, :version_pattern, :alternatives
 
+    # Finds for a interface by its name and the current version
+    # @param name [String]
+    # @param version [String] just like '0.2.1'
+    # @param alternatives: [Array]
+    # @raises`::Taksi::Registry::InterfaceNotFoundError`
+    # @return Class the class of interface
     def self.find(name, version, alternative: nil)
       ::Taksi::Registry.find(name, version, alternative)
     end
@@ -28,7 +36,7 @@ module Taksi
       attr_reader :skeleton
 
       def find(version, alternative = nil)
-        ::Taksi::Registry.find(interface_name, version, alternative)
+        ::Taksi::Registry.find(@interface_definition.interface_name, version, alternative)
       end
 
       def initiate(interface_definition)

data/lib/taksi/registry.rb

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
 
-require 'forwardable'
 module Taksi
   class Registry
     include ::Singleton
 
+    NAME_REGEX = %r{^[a-z\-_/]{1,80}$}i
+
     class << self
       extend ::Forwardable
 
@@ -19,6 +20,11 @@ module Taksi
     end
 
     def add(klass, name)
+      unless name.to_s.match?(NAME_REGEX)
+        raise StandardError,
+              "Invalid interface name '#{name}', it must to match regex '#{NAME_REGEX.inspect}'"
+      end
+
       sym_name = name.to_sym
 
       @interfaces[sym_name] ||= []
@@ -41,7 +47,7 @@ module Taksi
 
         next true if alternative.nil?
 
-        next true if interface.alternatives.blank?
+        next true if interface.alternatives.nil?
 
         next true if interface.alternatives.include?(alternative)
 

data/lib/taksi/values/dynamic.rb

@@ -3,18 +3,11 @@
 module Taksi
   module Values
     class Dynamic
-      attr_reader :component, :name, :field
+      attr_reader :component, :name
 
-      def initialize(component, name, field = nil)
+      def initialize(component, name)
         @component = component
         @name = name
-        @field = field
-      end
-
-      def path
-        return field if field
-
-        "#{component.id}.#{name}"
       end
 
       def as_json

data/lib/taksi/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Taksi
-  VERSION = '0.2.1'
+  VERSION = '0.2.3'
 end

data/lib/taksi.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'singleton'
+require 'forwardable'
 
 require 'taksi/version'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: taksi
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.3
 platform: ruby
 authors:
 - Israel Trindade
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-07-11 00:00:00.000000000 Z
+date: 2023-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler