foobara 0.2.4 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7febf2c9b13ecbbbeb552dbfa7cf278805b60e808b01c64abcbd531264ff3486
-  data.tar.gz: 72386588ea5c433a61585c48cd904143baf9b04165a2c62328a87f089851c4d0
+  metadata.gz: a3b6525afdbf01d8f0d56dce1f067430111781670ebac06dc4a90297e5fb1188
+  data.tar.gz: fc79448ff4613758061b9c6336855fed97b6328356d510b77eb438097d55c99d
 SHA512:
-  metadata.gz: 746004fcedb4287688d6f333b02c50d1b083591837be43f762eb4916670c7c65640d0c9cbbc6a202aaff84a461a20dce5d59c7ba6bc46ce0c5ffa28754baa374
-  data.tar.gz: 1cae511fedd5916ec97c872eb07ffdae224f9cf76e6f2643de3138a4d146d1049bac68af3ed5ba60ec3b9778a779db051f067562ed64982e6bfeb16e4702e759
+  metadata.gz: 46d2df3884c269014f64a0b040d867e63bf65bd4c0822a4d810e07a506f296a2c6a967be2437542e7d6b56af8080094f1510da9d8143e94880428bd816bf32ad
+  data.tar.gz: 878e815dad1a261fa6bf9fc64525d06ea6cef4c499770fa6f621487a1fce011a2781750e53b75c40f8f8d1d3db57ef4cd17e4c542fba899c2474ca3576e239ab

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+# [0.2.6] - 2025-10-30
+
+- Add a set inputs transformer
+
+# [0.2.5] - 2025-10-27
+
+- Do not allow commands to be connected multiple times via symbol/string
+- Add CommandConnector#all_exposed_command_names
+- pry is again required by default in development/test mode but can be skipped with SKIP_PRY env var
+
 # [0.2.4] -2025-10-26
 
 - Remove all uses of .require_project_file and deprecate it

data/README.md

@@ -2124,10 +2124,103 @@ the build will fail if test coverage is below 100%.
 
 You should be able to do the typical stuff:
 
+### 1. Cloning repository:
+Fork the repository and run this(Only for SSH):
+
+```
+git clone git@github.com:${your_github_username}/foobara.git
+```
+
+Create a new branch for you to push into
+
+```
+git checkout -b <branch-name>
+```
+
+Now navigate to project directory
+
 ```
-git clone git@github.com:foobara/foobara
 cd foobara
+```
+
+### 2. Installing mise (LINUX/WSL)
+Mise is a package manager and helps with managing different versions of ruby. It allows you to switch different versions of ruby.
+
+The installation docs might be updated by mise so here's the reference to that: [Installation Docs](https://mise.jdx.dev/installing-mise.html)
+
+***If you already installed by following mise's docs then, you can skip this section***
+
+Else to setup mise follow the script given below:
+
+```
+sudo apt update -y && sudo apt install -y gpg wget \
+build-essential \
+  libssl-dev zlib1g-dev libreadline-dev libyaml-dev libxml2-dev \
+  libxslt1-dev libffi-dev libgdbm-dev autoconf bison
+wget -qO - https://mise.jdx.dev/gpg-key.pub | gpg --dearmor | sudo tee /etc/apt/keyrings/mise-archive-keyring.gpg 1> /dev/null
+echo "deb [signed-by=/etc/apt/keyrings/mise-archive-keyring.gpg arch=amd64] https://mise.jdx.dev/deb stable main" | sudo tee /etc/apt/sources.list.d/mise.list
+sudo apt update
+sudo apt install -y mise
+```
+
+Verify if it's installed or not by running:
+
+```
+mise -v
+```
+
+It should print out an ascii-art saying "mise-en-place"
+
+### 3. Install required ruby version
+In this project, currently we require ruby version >=3.4 so we can install it manually using the command below
+
+```
+mise use -g ruby@3.4
+```
+
+In case, you want to automatically activate the ruby version whenever you navigate to the directory containing .ruby-version file
+
+This helps a lot when you have lot of ruby projects with different versions and don't want to switch ruby versions each time manually
+
+```
+mise settings add idiomatic_version_file_enable_tools ruby
+```
+
+### 4. Activating mise
+We can activate mise so that it will update the environment variables such that we will use the correct version of ruby.
+
+```
+echo 'eval "$(mise activate bash)"' >> ~/.bashrc
+```
+
+Restart the terminal
+
+Now environment variables are updated and you can verify it by running:
+
+```
+ruby -v
+```
+
+It will print out the ruby version, which is mentioned in .ruby-version file
+
+You can list out your mise tools and its versions by running:
+
+```
+mise list
+```
+
+### 5. Running tests
+Before running test-suite, we need to install all the dependencies
+
+Run this to install all the dependencies:
+
+```
 bundle
+```
+
+Run the tests now:
+
+```
 rake
 ```
 

data/projects/command_connectors/lib/foobara/command_connectors.rb

@@ -17,6 +17,7 @@ module Foobara
         CommandConnector.add_desugarizer Desugarizers.rename :response, :response_mutators
         CommandConnector.add_desugarizer Desugarizers::Attributes::OnlyInputs
         CommandConnector.add_desugarizer Desugarizers::Attributes::RejectInputs
+        CommandConnector.add_desugarizer Desugarizers::SetInputs
         CommandConnector.add_desugarizer Desugarizers::Attributes::OnlyResult
         CommandConnector.add_desugarizer Desugarizers::Attributes::RejectResult
         CommandConnector.add_desugarizer Desugarizers::Attributes::InputsFromYaml

data/projects/command_connectors/src/command_connector.rb

@@ -1,6 +1,7 @@
 module Foobara
   class CommandConnector
     class UnexpectedSensitiveTypeInManifestError < StandardError; end
+    class AlreadyConnectedError < StandardError; end
 
     include Concerns::Desugarizers
 
@@ -305,7 +306,15 @@ module Foobara
     end
 
     def connect_delayed(registerable_name, *args, **opts)
-      delayed_connections[registerable_name.to_s] = { args:, opts: }
+      key = registerable_name.to_s
+
+      if delayed_connections.key?(key)
+        # :nocov:
+        raise AlreadyConnectedError, "Already connected #{key}"
+        # :nocov:
+      else
+        delayed_connections[key] = { args:, opts: }
+      end
     end
 
     def delayed_connections
@@ -313,6 +322,8 @@ module Foobara
     end
 
     def process_delayed_connections
+      return if delayed_connections.empty?
+
       delayed_connections.each_pair do |registerable_name, arg_hash|
         args = arg_hash[:args]
         opts = arg_hash[:opts]
@@ -665,6 +676,10 @@ module Foobara
       command_registry.foobara_all_command(mode: Namespace::LookupMode::ABSOLUTE_SINGLE_NAMESPACE)
     end
 
+    def all_exposed_command_names
+      all_exposed_commands.map(&:full_command_name)
+    end
+
     def all_exposed_type_names
       # TODO: cache this or better yet cache #foobara_manifest
       foobara_manifest[:type].keys.sort.map(&:to_s)

data/projects/command_connectors/src/desugarizers/set_inputs.rb

@@ -0,0 +1,48 @@
+require_relative "../desugarizer"
+
+module Foobara
+  module CommandConnectors
+    module Desugarizers
+      class SetInputs < Desugarizer
+        def applicable?(args_and_opts)
+          _args, opts = args_and_opts
+
+          return false unless opts.key?(:inputs_transformers)
+
+          transformers = opts[:inputs_transformers]
+          transformers = Util.array(transformers)
+
+          transformers.any? do |transformer|
+            transformer.is_a?(::Hash) && transformer.key?(:set)
+          end
+        end
+
+        def desugarize(args_and_opts)
+          args, opts = args_and_opts
+
+          transformers = opts[:inputs_transformers]
+          is_array = transformers.is_a?(::Array)
+
+          transformers = Util.array(transformers)
+
+          transformers = transformers.map do |transformer|
+            if transformer.is_a?(::Hash) && transformer.key?(:set)
+              AttributesTransformers.set(transformer[:set])
+            else
+              # TODO: add a test for this
+              # :nocov:
+              transformer
+              # :nocov:
+            end
+          end
+
+          transformers = transformers.first unless is_array
+
+          opts = opts.merge(inputs_transformers: transformers)
+
+          [args, opts]
+        end
+      end
+    end
+  end
+end

data/projects/command_connectors/src/serializers/atomic_serializer.rb

@@ -1,6 +1,11 @@
 module Foobara
   module CommandConnectors
     module Serializers
+      # This seems to interpret "Atomic" as load the first entity you hit but not deeper entities.
+      # Other interpretations it could have been:
+      # 1) If top-level is an entity, load it and convert all nested entities to primary keys,
+      #   otherwise, convert all entities to primary keys
+      # 2) Once past the first model, all entities are cast to primary keys
       class AtomicSerializer < SuccessSerializer
         def serialize(object)
           case object

data/projects/namespace/src/ambiguous_registry.rb

@@ -8,6 +8,12 @@ module Foobara
       def register(scoped)
         short_name = scoped.scoped_short_name
         registry[short_name] ||= []
+        # This kind of error should only happen in test suites that need to unregister/reregister things
+        # with different object_ids but the same scoped full name. So will check it in commented out.
+        # if registry[short_name].map(&:scoped_full_name).include?(scoped.scoped_full_name)
+        #   raise "Already registered: #{scoped.scoped_full_name}"
+        # end
+
         registry[short_name] |= [scoped]
       end
 

data/projects/type_declarations/src/attributes_transformers/set.rb

@@ -0,0 +1,77 @@
+module Foobara
+  class AttributesTransformers < TypeDeclarations::TypedTransformer
+    class << self
+      def next_index
+        @index ||= 0
+        @index += 1
+      end
+
+      def set(attribute_names_to_values)
+        if attribute_names_to_values.empty?
+          # :nocov:
+          raise ArgumentError, "You must specify at least one attribute name/value pair"
+          # :nocov:
+        end
+
+        symbol = symbol_for_attribute_names([*attribute_names_to_values.keys, next_index.to_s.to_sym])
+        existing = Set.foobara_lookup(symbol, mode: Namespace::LookupMode::DIRECT)
+
+        return existing if existing
+
+        transformer_class = Class.new(Set)
+        transformer_class.attribute_names_to_values = attribute_names_to_values
+
+        Namespace::NamespaceHelpers.foobara_autoset_scoped_path(transformer_class, set_namespace: true)
+        transformer_class.scoped_namespace.foobara_register(transformer_class)
+
+        transformer_class
+      end
+    end
+
+    class Set < AttributesTransformers
+      class << self
+        attr_accessor :attribute_names_to_values
+
+        def symbol
+          if attribute_names_to_values
+            symbol_for_attribute_names(attribute_names_to_values.keys)
+          end
+        end
+
+        def will_set_scoped_path?
+          true
+        end
+      end
+
+      def to_type_declaration
+        # TODO: test this
+        # :nocov:
+        if from_type
+          from_declaration = from_type.declaration_data
+          TypeDeclarations::Attributes.reject(from_declaration, *self.class.attribute_names_to_values.keys)
+        end
+        # :nocov:
+      end
+
+      def from_type_declaration
+        if to_type
+          to_declaration = to_type.declaration_data
+          TypeDeclarations::Attributes.reject(to_declaration, *self.class.attribute_names_to_values.keys)
+        end
+      end
+
+      def transform(inputs)
+        to_merge = {}
+
+        self.class.attribute_names_to_values.each_pair do |input_name, value|
+          if value.is_a?(::Proc)
+            value = value.call
+          end
+          to_merge[input_name] = value
+        end
+
+        inputs.merge(to_merge)
+      end
+    end
+  end
+end

data/version.rb

@@ -1,6 +1,6 @@
 module Foobara
   module Version
-    VERSION = "0.2.4".freeze
+    VERSION = "0.2.6".freeze
     MINIMUM_RUBY_VERSION = ">= 3.4.0".freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: foobara
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.6
 platform: ruby
 authors:
 - Miles Georgi
@@ -214,6 +214,7 @@ files:
 - projects/command_connectors/src/desugarizers/attributes/reject_result.rb
 - projects/command_connectors/src/desugarizers/auth.rb
 - projects/command_connectors/src/desugarizers/rename_key.rb
+- projects/command_connectors/src/desugarizers/set_inputs.rb
 - projects/command_connectors/src/desugarizers/symbols_to_true.rb
 - projects/command_connectors/src/request_mutator.rb
 - projects/command_connectors/src/response_mutator.rb
@@ -422,6 +423,7 @@ files:
 - projects/type_declarations/src/attributes_transformers/from_yaml.rb
 - projects/type_declarations/src/attributes_transformers/only.rb
 - projects/type_declarations/src/attributes_transformers/reject.rb
+- projects/type_declarations/src/attributes_transformers/set.rb
 - projects/type_declarations/src/caster.rb
 - projects/type_declarations/src/desugarizer.rb
 - projects/type_declarations/src/desugarizer_pipeline.rb