taksi 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c176b6593b9e570169fa5ec6103bfd635c8bae751342ce7b8c986ec3fa43df3d
-  data.tar.gz: e84fe608e7b15263084b9f3f745eba7e9cf47d8460ecb02032ad930fe85e1c14
+  metadata.gz: e57c4a5876a120b859b3642f790bf13d7f45a691ca74e2a3967d094589b2605a
+  data.tar.gz: da96e2c711489b11c4d24f88cb8e3ae738774c484772e3a9c5e0106ab13f5573
 SHA512:
-  metadata.gz: b6b421c3efe426c48c934ccfc9ba2ae385a74fd97cc63fc0c4fbca14070f547ab0003d09abc6fe724ea6dd064d8d49d00a08bf268193850337566b945760be7a
-  data.tar.gz: 45fa852395860e6b3ade5d413518d2cca268cefbd9faeb21aa83d269e8c74d5d3d5ed9ba2c7fc27906d9d55222acea5d6f53396f0945ae6e54374704a2c14e05
+  metadata.gz: 1f52db226be934f1c70c127f2c75b105c1cdc65efd8443a76e338cb62769c95f2511e3b282521d753d6e34cc8791282889b7ef8d05bc471e3ad6b0fc87f8c316
+  data.tar.gz: 229d3fbd97e55eaa3e70a3dd735e2e3b6f4947d9b3b91a962d73a2680c8bccd0c9d04af2a63bff3fcd37810519e65af3c52adb37111c801b8098d2ebdec793e9

data/README.md

@@ -23,6 +23,7 @@ class Components::Users::ProfileResume
 
   content do
     name Taksi::Dynamic
+    profile_kind Taksi::Static, 'resume'
 
     details do
       age Taksi::Dynamic
@@ -69,8 +70,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
 

data/lib/taksi/components/field.rb

@@ -10,6 +10,10 @@ 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 = []
 
@@ -23,6 +27,8 @@ module Taksi
         "#{parent.name}.#{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?
 
@@ -33,12 +39,17 @@ module Taksi
         raise NameError, "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,13 +70,19 @@ module Taksi
         @parent.nil?
       end
 
+      def dynamic?
+        return @nested_fields.any?(&:dynamic?) if @value.nil?
+
+        @value.dynamic?
+      end
+
       def method_missing(name, *args, &block)
         return super if @defined
 
         @nested_fields << self.class.new(skeleton, name, *args, parent: self, &block)
       end
 
-      def respond_to_missing?(name)
+      def respond_to_missing?(name, *)
         return super if @defined
 
         true

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,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'forwardable'
 module Taksi
   class Registry
     include ::Singleton
@@ -41,7 +40,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/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Taksi
-  VERSION = '0.2.1'
+  VERSION = '0.2.2'
 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.2
 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