instruct 0.1.0a1

data/lib/instruct/utils/serializer.rb

@@ -0,0 +1,70 @@
+require 'psych'
+require 'yaml'
+
+module Instruct::Serializer
+
+    class << self
+      def dump(prompt_or_completion)
+        YAML.dump(prompt_or_completion)
+      end
+
+      def load(prompt_or_completion_bytes, permitted_classes: [])
+        permitted_classes = permitted_classes + @@permitted_classes.dup
+        # permitted_classes += PERMITTED_CLASSES
+        # all instruct classes at load time should be permitted
+        doc = Psych.parse(prompt_or_completion_bytes)
+        transform_ast(doc, permitted_classes)
+        doc.to_ruby
+      end
+
+      def add_permitted_class(klass)
+        @@permitted_classes << klass
+      end
+
+      private
+
+      @@permitted_classes =  Instruct.constants.map { |const| Instruct.const_get(const) }.select { |const| const.is_a?(Class) }
+
+      def transform_ast(node, permitted_classes)
+        if node.is_a?(Psych::Nodes::Mapping) && node.tag&.start_with?('!ruby/instruct:')
+          class_id, version = node.tag.split(':').last.split('@')
+          klass = ClassRegistry.lookup(class_id)
+          node.tag = "!ruby/object:#{klass}"
+          # add a version integer to the object
+          version_node_key = Psych::Nodes::Scalar.new('version')
+          version_node_value = Psych::Nodes::Scalar.new(version.to_s) # Ensure it's an integer
+          node.children << version_node_key
+          node.children << version_node_value
+          if klass == nil
+            raise ArgumentError, "Class #{klass} not found in serialization registry"
+          end
+        elsif node.is_a?(Psych::Nodes::Mapping) && node.tag&.start_with?('!ruby/object:')
+          klass = node.tag.sub('!ruby/object:', '')
+          if !permitted_classes.include?(klass)
+            raise ArgumentError, "Class #{klass} not permitted"
+          end
+        end
+
+        if node.respond_to?(:children) && node.children
+          node.children.each { |child| transform_ast(child, permitted_classes) }
+        end
+      end
+    end
+
+
+
+
+    module ClassRegistry
+      @registry = {}
+      def self.register(class_id, current_klass)
+        @registry[class_id.to_s] = current_klass
+      end
+
+      def self.lookup(class_id)
+        @registry[class_id.to_s]
+      end
+
+    end
+
+
+end

data/lib/instruct/utils/symbolize_keys.rb

@@ -0,0 +1,22 @@
+module Instruct
+  module SymbolizeKeys
+    class << self
+      def recursive(hash)
+        {}.tap do |h|
+          hash.each { |key, value| h[key.to_sym] = map_value(value) }
+        end
+      end
+
+      def map_value(thing)
+        case thing
+        when Hash
+          recursive(thing)
+        when Array
+          thing.map { |v| map_value(v) }
+        else
+          thing
+        end
+      end
+    end
+  end
+end

data/lib/instruct/utils/variables.rb

@@ -0,0 +1,37 @@
+# Provides a simple hash-like interface for storing variables in LM.
+class Instruct::LM
+  module Variables
+    attr_reader :variables
+
+    def [](key)
+      raise ArgumentError, "key must not be nil" if key.nil?
+      key = key.to_sym
+      @variables[key]
+    end
+
+    private
+
+    def []=(key, value)
+      key = key.to_sym
+      @variables[key] = value
+    end
+
+    def capture_result_in_variable(response, arr_name: nil, name: nil, **kwargs)
+      if arr_name
+        self[arr_name] ||= []
+        self[arr_name] << response
+      end
+      if name
+        self[name] = response
+      end
+    end
+
+    def dup_variables
+      @variables.dup
+    end
+
+    def initialize_variables(variables = {})
+      @variables = variables.dup
+    end
+  end
+end

data/lib/instruct/version.rb

@@ -0,0 +1,3 @@
+module Instruct
+  VERSION = "0.1.0a1"
+end

data/lib/instruct.rb

@@ -0,0 +1,74 @@
+require_relative "instruct/version"
+
+# stdlib
+require 'erb'
+require 'ostruct'
+
+# dependencies
+require 'attributed-string'
+# require 'async/http/faraday'
+
+
+
+# utils
+require_relative "instruct/utils/serializer"
+require_relative "instruct/utils/serializable_with_version"
+require_relative "instruct/utils/middleware_chain"
+require_relative "instruct/utils/symbolize_keys"
+require_relative "instruct/utils/variables"
+
+# modules
+
+require_relative "instruct/compile_erb"
+require_relative "instruct/env"
+require_relative "instruct/error"
+require_relative "instruct/model"
+require_relative "instruct/gen/completion_response"
+require_relative "instruct/gen/completion_request"
+require_relative "instruct/gen/generate_completion"
+require_relative "instruct/gen/gen"
+require_relative "instruct/middleware/chat_completion_middleware"
+require_relative "instruct/middleware/chomp_middleware"
+require_relative "instruct/prompt"
+
+require_relative "instruct/helpers/erb_helper"
+require_relative "instruct/helpers/gen_helper"
+require_relative "instruct/helpers/model_helper"
+require_relative "instruct/helpers/refinements"
+require_relative "instruct/helpers/helpers"
+
+# optional dependencies
+begin
+  require 'rainbow'
+rescue LoadError
+end
+
+# if the caller is using ruby-openai gem
+begin
+  require "ruby/openai"
+rescue LoadError
+end
+
+if defined? ::OpenAI
+  require_relative "instruct/llms/openai/middleware"
+  require_relative "instruct/llms/openai/completion_model"
+  require_relative "instruct/llms/openai/completion_response"
+  require_relative "instruct/llms/openai/chat_completion_response"
+  Instruct.openai_loaded = true
+else
+end
+
+# if the caller is using ruby/anthropic gem
+begin require "anthropic"
+rescue LoadError
+end
+
+if defined? ::Anthropic
+  require_relative "instruct/llms/anthropic/middleware"
+  require_relative "instruct/llms/anthropic/completion_model"
+  require_relative "instruct/llms/anthropic/messages_completion_response"
+  Instruct.anthropic_loaded = true
+else
+end
+
+require "instruct/railtie" if defined?(Rails::Railtie)

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: instruct
+version: !ruby/object:Gem::Version
+  version: 0.1.0a1
+platform: ruby
+authors:
+- Andrew Mackross
+autorequire:
+bindir: bin
+cert_chain: []
+date: 1980-01-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ostruct
+  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: mutex_m
+  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: attributed-string
+  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'
+description:
+email: andrew@mackross.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- SCRATCHPAD.md
+- lib/instruct.rb
+- lib/instruct/compile_erb.rb
+- lib/instruct/env.rb
+- lib/instruct/error.rb
+- lib/instruct/gen/completion_request.rb
+- lib/instruct/gen/completion_response.rb
+- lib/instruct/gen/gen.rb
+- lib/instruct/gen/generate_completion.rb
+- lib/instruct/helpers/erb_helper.rb
+- lib/instruct/helpers/gen_helper.rb
+- lib/instruct/helpers/helpers.rb
+- lib/instruct/helpers/model_helper.rb
+- lib/instruct/helpers/refinements.rb
+- lib/instruct/llms/anthropic/completion_model.rb
+- lib/instruct/llms/anthropic/messages_completion_response.rb
+- lib/instruct/llms/anthropic/middleware.rb
+- lib/instruct/llms/openai/chat_completion_response.rb
+- lib/instruct/llms/openai/completion_model.rb
+- lib/instruct/llms/openai/completion_response.rb
+- lib/instruct/llms/openai/middleware.rb
+- lib/instruct/middleware/chat_completion_middleware.rb
+- lib/instruct/middleware/chomp_middleware.rb
+- lib/instruct/model.rb
+- lib/instruct/prompt.rb
+- lib/instruct/rails/active_job_object_serializer.rb
+- lib/instruct/rails/active_record_coders.rb
+- lib/instruct/railtie.rb
+- lib/instruct/utils/middleware_chain.rb
+- lib/instruct/utils/serializable_with_version.rb
+- lib/instruct/utils/serializer.rb
+- lib/instruct/utils/symbolize_keys.rb
+- lib/instruct/utils/variables.rb
+- lib/instruct/version.rb
+homepage: https://instruct-rb.com
+licenses:
+- Apache-2.0
+metadata:
+  source_code_uri: https://github.com/instruct-rb/instruct
+  homepage_uri: https://instruct-rb.com
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.16
+signing_key:
+specification_version: 4
+summary: Instruct LLMs to do what you want
+test_files: []