tudla_contracts 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ae48bdd0b24050feb695a73d69fc487f57e5e1fe3eb77d47b2e46e4a0949474a
+  data.tar.gz: 12d6dd76439145a4194169fa638a8bdcd7884fd6b777447449832e4826b3bc99
+SHA512:
+  metadata.gz: 3a5366b20effc045d051affe7c92a4fbea212adf884cb1ab5d8b138d8f3224106a0f8e184058788a3de7263bb8cc37c4963b2624b121ca410f7014a4f95e3f23
+  data.tar.gz: f41cf8279508eb41c73e66740dc09e10a6261ae3113f943c4d827a2733eefdd62c2030348bd43de675a40c7efb9f49a2ea7a7db9b5c99faa2af9815a02203abc

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 3.0
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/.ruby-version

@@ -0,0 +1 @@
+3.3.4

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-02-08
+
+- Initial release
+- Supports dashboard section definitions
+- Supports show tab definitions

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# 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, caste, color, 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 email 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
+[INSERT CONTACT METHOD].
+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.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 The Tudla Authors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,175 @@
+# TudlaContracts
+
+[![Gem Version](https://badge.fury.io/rb/tudla_contracts.svg)](https://badge.fury.io/rb/tudla_contracts)
+[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE.txt)
+[![Ruby](https://img.shields.io/badge/ruby-%3E%3D%203.0.0-ruby.svg)](https://www.ruby-lang.org)
+
+A shared contracts gem for Tudla integrations. This gem provides base classes, interfaces, and a registry system for building pluggable integrations with the Tudla platform.
+
+## Features
+
+- **Integration Registry** - Thread-safe registration and lookup of integration providers
+- **Host Interface** - Abstract interface for host applications to provide user, task, and project data
+- **TimeSheet Base** - Base class for building time sheet integrations with a standardized API
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "tudla_contracts"
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install tudla_contracts
+```
+
+## Requirements
+
+- Ruby >= 3.0.0
+
+## Usage
+
+### Integration Registry
+
+Register your integration provider using fully qualified class name strings:
+
+```ruby
+TudlaContracts::Integrations::Registry.register(
+  :my_provider,
+  type: :time_sheet,
+  provider_class: "MyGem::Providers::TimeSheetProvider",
+  config_class: "MyGem::Config::TimeSheetConfig"
+)
+```
+
+Look up registered integrations:
+
+```ruby
+# Find a specific provider (returns class name string)
+provider_class_name = TudlaContracts::Integrations::Registry.find(:my_provider)
+# => "MyGem::Providers::TimeSheetProvider"
+
+# Instantiate the provider
+provider = provider_class_name.constantize.new(config)
+
+# Get all providers of a type
+time_sheet_providers = TudlaContracts::Integrations::Registry.all_of_type(:time_sheet)
+
+# List available provider names
+TudlaContracts::Integrations::Registry.available_providers
+# => ["my_provider"]
+
+# Get config class for a provider (returns class name string)
+config_class_name = TudlaContracts::Integrations::Registry.config_class_for(:my_provider)
+# => "MyGem::Config::TimeSheetConfig"
+```
+
+### Host Interface
+
+Implement the host interface to provide data from your application:
+
+```ruby
+class MyHostInterface < TudlaContracts::Integrations::HostInterface
+  def available_users_for_user(user)
+    # Return array of TudlaContracts::Integrations::User structs
+  end
+
+  def available_tasks_for_user(user)
+    # Return array of TudlaContracts::Integrations::Task structs
+  end
+
+  def available_projects_for_user(user)
+    # Return array of TudlaContracts::Integrations::Project structs
+  end
+
+  def find_task(task_id)
+    # Return a TudlaContracts::Integrations::Task struct
+  end
+end
+```
+
+Available data structures:
+
+```ruby
+TudlaContracts::Integrations::User.new(id:, name:, email:)
+TudlaContracts::Integrations::Task.new(id:, name:, project_name:)
+TudlaContracts::Integrations::Project.new(id:, name:)
+```
+
+### TimeSheet Integration
+
+Create a time sheet provider by extending the base class:
+
+```ruby
+class MyTimeSheetProvider < TudlaContracts::TimeSheet::Base
+  def daily_activities(user, date, task_ids = nil)
+    # Fetch and return activities for the given date
+    # Returns array of TudlaContracts::TimeSheet::ActivitySummary
+  end
+end
+```
+
+Activity summary structure:
+
+```ruby
+TudlaContracts::TimeSheet::ActivitySummary.new(
+  task_id:,
+  total_seconds:,
+  notes:,
+  remote_id:,
+  metadata:
+)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+```bash
+# Install dependencies
+bin/setup
+
+# Run tests
+bundle exec rake spec
+
+# Run linter
+bundle exec rubocop
+
+# Start interactive console
+bin/console
+```
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Releasing
+
+1. Update the version number in `lib/tudla_contracts/version.rb`
+2. Update `CHANGELOG.md` with the new version's changes
+3. Run `bundle exec rake release` to create a git tag, push commits and tags, and publish to RubyGems
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/tibomogul/tudla_contracts. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](CODE_OF_CONDUCT.md).
+
+1. Fork it
+2. Create your feature branch (`git checkout -b feature/my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin feature/my-new-feature`)
+5. Create a new Pull Request
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](LICENSE.txt).
+
+## Code of Conduct
+
+Everyone interacting in the TudlaContracts project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/tudla_contracts/integrations/host_interface.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module TudlaContracts
+  module Integrations
+    User = Struct.new(:id, :name, :email)
+    Task = Struct.new(:id, :name, :project_name)
+    Project = Struct.new(:id, :name)
+    # Host application interface for TudlaContracts
+    class HostInterface
+      # Returns an array of users available to the user
+      # @param user [User] The host application User object
+      # @return [Array<User>]
+      def available_users_for_user(user)
+        raise NotImplementedError, "#{self.class.name} must implement #avaliable_users_for_user"
+      end
+
+      # Returns an array of tasks available to the user
+      # @param user [User] The host application User object
+      # @return [Array<Task>]
+      def available_tasks_for_user(user)
+        raise NotImplementedError, "#{self.class.name} must implement #avaliable_tasks_for_user"
+      end
+
+      # Returns an array of projects available to the user
+      # @param user [User] The host application User object
+      # @return [Array<Project>]
+      def available_projects_for_user(user)
+        raise NotImplementedError, "#{self.class.name} must implement #avaliable_projects_for_user"
+      end
+
+      # Returns a Tudla task by id
+      # @param task_id [Integer] The Tudla task id
+      # @return [Task]
+      def find_task(task_id)
+        raise NotImplementedError, "#{self.class.name} must implement #find_task"
+      end
+    end
+  end
+end

data/lib/tudla_contracts/integrations/registry.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module TudlaContracts
+  module Integrations
+    # Shared class for registering and looking up integrations
+    class Registry
+      # Thread-safe storage for registered integrations
+      @integrations = {}
+      # Thread-safe storage for registered view definitions
+      @view_slots = {}
+
+      VALID_TYPES = %w[time_sheet].freeze
+
+      class << self
+        # Method called by gems to register themselves
+        # @param name [String, Symbol] Unique identifier for the integration
+        # @param type [String, Symbol] Integration type (e.g., :time_sheet)
+        # @param provider_class [String] Fully qualified class name of the provider
+        # @param config_class [String] Fully qualified class name of the config
+        def register(name, type:, provider_class:, config_class:)
+          @integrations[name.to_s] = {
+            type: type.to_s,
+            provider_class: provider_class.to_s,
+            config_class: config_class.to_s
+          }
+        end
+
+        # Reset the registry
+        def reset!
+          @integrations = {}
+          @view_slots = {}
+        end
+
+        # Method called by gems to register view definitions for slots
+        # @param slot [String, Symbol] Slot name
+        # @param view_definition [Object] An instance of a class that inherits from ViewDefinitions::Base
+        def register_view_for_slot(slot, view_definition)
+          unless view_definition.class.ancestors.any? { |a| a.name&.end_with?("ViewDefinitions::Base") }
+            raise ArgumentError, "view_definition must be an instance of a class that inherits from ViewDefinitions::Base"
+          end
+
+          @view_slots[slot.to_s] ||= []
+          @view_slots[slot.to_s] << view_definition
+        end
+
+        # Used by the Host App to look up view components for a specific slot
+        # @param slot [String, Symbol] Slot name
+        # @return [Array<String>] Array of fully qualified view component class names
+        def views_for_slot(slot)
+          @view_slots[slot.to_s] || []
+        end
+
+        # Used by the Host App to look up all registered slots
+        def registered_slots
+          @view_slots.keys
+        end
+
+        # Used by the Host App to look up a specific provider
+        # @param name [String, Symbol] Integration name
+        # @return [String] Fully qualified provider class name
+        def find(name)
+          entry = @integrations[name.to_s]
+          raise ArgumentError, "Unknown integration: #{name}" unless entry
+
+          entry[:provider_class]
+        end
+
+        # Used by the Host App to look up all integrations of a specific type
+        def all_of_type(type)
+          @integrations.select { |_, v| v[:type] == type.to_s }.values
+        end
+
+        # Used by the Host App to find the config class for polymorphic associations
+        # @param name [String, Symbol] Integration name
+        # @return [String, nil] Fully qualified config class name or nil if not found
+        def config_class_for(name)
+          entry = @integrations[name.to_s]
+          return nil unless entry
+
+          entry[:config_class]
+        end
+
+        # Used to populate UI dropdowns
+        def available_providers
+          @integrations.keys
+        end
+      end
+    end
+  end
+end

data/lib/tudla_contracts/integrations/view_definitions/base.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module TudlaContracts
+  module Integrations
+    module ViewDefinitions
+      # Base class for all view definitions
+      # Subclasses must implement the #visible? method
+      class Base
+        attr_reader :id, :label, :component_class, :priority, :condition
+
+        def initialize(id:, label:, component_class:, priority: 10, if: nil)
+          @id = id
+          @label = label
+          @component_class = component_class
+          @priority = priority
+          # Capture the conditional logic (lambda/proc)
+          @condition = binding.local_variable_get(:if)
+        end
+
+        # Helper to check visibility within a specific context
+        def visible?(context, *args)
+          return true if @condition.nil?
+
+          # Execute the condition in the context of the view (context)
+          context.instance_exec(*args, &@condition)
+        end
+      end
+    end
+  end
+end

data/lib/tudla_contracts/integrations/view_definitions/dashboard_section_definition.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module TudlaContracts
+  module Integrations
+    module ViewDefinitions
+      # Defines a view to be displayed in the dashboard as one row/section
+      class DashboardSectionDefinition < Base
+      end
+    end
+  end
+end

data/lib/tudla_contracts/integrations/view_definitions/show_tab_definition.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module TudlaContracts
+  module Integrations
+    module ViewDefinitions
+      # Defines a tab to be displayed in the show view
+      class ShowTabDefinition < Base
+      end
+    end
+  end
+end

data/lib/tudla_contracts/integrations/view_defintions.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+Dir.glob(File.join(__dir__, "view_definitions/**/*.rb")).each { |file| require file }

data/lib/tudla_contracts/time_sheet/base.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module TudlaContracts
+  module TimeSheet
+    ActivitySummary = Struct.new(:task_id, :total_seconds, :notes, :remote_id, :metadata)
+
+    # Base class for time sheet integrations
+    class Base
+      attr_reader :config
+
+      def initialize(config)
+        @config = config
+      end
+
+      # The core method for retrieving data.
+      # @param user [User] The host application User object
+      # @param date The date for which to retrieve activities
+      # @param task_ids [Array<Integer>] Optional filter for specific tasks
+      # @return
+      def daily_activities(user, date, task_ids)
+        raise NotImplementedError, "#{self.class.name} must implement #daily_activities"
+      end
+    end
+  end
+end

data/lib/tudla_contracts/version.rb

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

data/lib/tudla_contracts.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative "tudla_contracts/version"
+require_relative "tudla_contracts/integrations/registry"
+require_relative "tudla_contracts/integrations/host_interface"
+require_relative "tudla_contracts/integrations/view_defintions"
+require_relative "tudla_contracts/time_sheet/base"
+
+module TudlaContracts
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/sig/tudla_contracts.rbs

@@ -0,0 +1,4 @@
+module TudlaContracts
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: tudla_contracts
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tibo Mogul
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2026-02-07 00:00:00.000000000 Z
+dependencies: []
+description: Tudla Contracts - a shared gem for Tudla integrations
+email:
+- tibo.mogul@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/tudla_contracts.rb
+- lib/tudla_contracts/integrations/host_interface.rb
+- lib/tudla_contracts/integrations/registry.rb
+- lib/tudla_contracts/integrations/view_definitions/base.rb
+- lib/tudla_contracts/integrations/view_definitions/dashboard_section_definition.rb
+- lib/tudla_contracts/integrations/view_definitions/show_tab_definition.rb
+- lib/tudla_contracts/integrations/view_defintions.rb
+- lib/tudla_contracts/time_sheet/base.rb
+- lib/tudla_contracts/version.rb
+- sig/tudla_contracts.rbs
+homepage: https://tibomogul.github.io/
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  rubygems_mfa_required: 'true'
+  homepage_uri: https://tibomogul.github.io/
+  source_code_uri: https://github.com/tibomogul/tudla_contracts
+  changelog_uri: https://github.com/tibomogul/tudla_contracts/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.11
+signing_key:
+specification_version: 4
+summary: Tudla Contracts
+test_files: []