gitlab-active-context 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c9175f119a8a209d2eea9acef05e4ac9dc93b33163d4b8162b80c85aa4e05dff
+  data.tar.gz: 7c2dcdf6a79f6626465411a58dcf014c0f4994437663bb650670bac37fcfc01f
+SHA512:
+  metadata.gz: 63b4611e8943b940b358542e26668ba4e0b3d4169f1fc6ad7cd5e706f7edee60f4cbf8101e01e4b3bd82c382682c3ac7c9663ecacc89542dd1b212926bf6dd12
+  data.tar.gz: a20c1bbba36d99adb3a6ccd8d527c70ed0a397a51608c86a41bf15caa866a3880cb09cf4263c986f7119eec9946c2f5d4525575b9a0e2d4b3c404dec70ca4ba3

data/.rubocop.yml

@@ -0,0 +1,3 @@
+inherit_gem:
+  gitlab-styles:
+    - rubocop-default.yml

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.2.5

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-11-27
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at mvanniekerk@gitlab.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/README.md

@@ -0,0 +1,41 @@
+# ActiveContext
+
+![Pipeline Status](https://gitlab.com/gitlab-org/search-team/ai/gitlab-active-context/badges/main/pipeline.svg)
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/active_context`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/active_context. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/active_context/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the ActiveContext project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/active_context/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: :rubocop

data/Steepfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+# D = Steep::Diagnostic
+#
+target :lib do
+  signature "sig"
+
+  check "lib"
+end

data/active_context.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative "lib/active_context/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "gitlab-active-context"
+  spec.version = ActiveContext::VERSION
+  spec.authors = ["GitLab"]
+  spec.email = ["gitlab_rubygems@gitlab.com"]
+
+  spec.summary = "Abstraction for indexing and searching vectors"
+  spec.description = "Abstraction for indexing and searching vectors"
+  spec.homepage = "https://gitlab.com/gitlab-org/search-team/ai/gitlab-active-context"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.1.0"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .gitlab-ci.yml appveyor Gemfile])
+    end
+  end
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+  spec.add_dependency "zeitwerk"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+  spec.metadata["rubygems_mfa_required"] = "true"
+end

data/lefthook.yml

@@ -0,0 +1,15 @@
+pre-push:
+  parallel: true
+  commands:
+    rubocop:
+      files: git diff --name-only --diff-filter=d $(git merge-base origin/master HEAD)..HEAD
+      glob: '*.rb'
+      run: bundle exec rubocop --parallel --no-server {files}
+    rspec:
+      files: git diff --name-only --diff-filter=d $(git merge-base origin/master HEAD)..HEAD
+      glob: '*.rb'
+      run: bundle exec rspec
+    steep:
+      files: git diff --name-only --diff-filter=d $(git merge-base origin/master HEAD)..HEAD
+      glob: '*.{rb,rbs}'
+      run: bundle exec steep check

data/lib/active_context/concerns/trackable.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module ActiveContext
+  module Concerns
+    module Trackable
+      def to_references
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/active_context/tracker.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module ActiveContext
+  class Tracker
+    def self.track!(*objects)
+      raise NotImplementedError
+    end
+  end
+end

data/lib/active_context/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ActiveContext
+  VERSION = "0.0.1"
+end

data/lib/active_context.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "zeitwerk"
+loader = Zeitwerk::Loader.for_gem
+loader.setup
+
+module ActiveContext
+  def self.track!(*objects)
+    Tracker.track!(*objects)
+  end
+end

data/sig/active_context.rbs

@@ -0,0 +1,5 @@
+module ActiveContext
+  VERSION: String
+
+  def self.track!: (*Array[Concerns::Trackable] objects) -> Integer
+end

data/sig/concerns/trackable.rbs

@@ -0,0 +1,7 @@
+module ActiveContext
+  module Concerns
+    module Trackable
+      def to_references: () -> untyped
+    end
+  end
+end

data/sig/tracker.rbs

@@ -0,0 +1,5 @@
+module ActiveContext
+  class Tracker
+    def self.track!: (*Array[Concerns::Trackable] objects) -> Integer
+  end
+end

data/sig/zeitwerk.rbs

@@ -0,0 +1,10 @@
+module Zeitwerk
+  class Loader
+    def self.for_gem: () -> Loader
+
+    def setup: () -> void
+    def eager_load: () -> void
+    def reload: () -> void
+    def push_dir: (String) -> void
+  end
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: gitlab-active-context
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- GitLab
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-11-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  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: Abstraction for indexing and searching vectors
+email:
+- gitlab_rubygems@gitlab.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- ".tool-versions"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- README.md
+- Rakefile
+- Steepfile
+- active_context.gemspec
+- lefthook.yml
+- lib/active_context.rb
+- lib/active_context/concerns/trackable.rb
+- lib/active_context/tracker.rb
+- lib/active_context/version.rb
+- sig/active_context.rbs
+- sig/concerns/trackable.rbs
+- sig/tracker.rbs
+- sig/zeitwerk.rbs
+homepage: https://gitlab.com/gitlab-org/search-team/ai/gitlab-active-context
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.19
+signing_key:
+specification_version: 4
+summary: Abstraction for indexing and searching vectors
+test_files: []