togglecraft 1.0.0

data/spec/togglecraft/utils_spec.rb

@@ -0,0 +1,506 @@
+# frozen_string_literal: true
+
+RSpec.describe ToggleCraft::Utils do
+  describe '.hash_key' do
+    it 'returns a value between 0 and 100' do
+      result = described_class.hash_key('test-key')
+      expect(result).to be >= 0
+      expect(result).to be < 100
+    end
+
+    it 'returns consistent results for the same key' do
+      key = 'user-123:new-feature'
+      result1 = described_class.hash_key(key)
+      result2 = described_class.hash_key(key)
+      expect(result1).to eq(result2)
+    end
+
+    it 'returns different results for different keys' do
+      result1 = described_class.hash_key('key1')
+      result2 = described_class.hash_key('key2')
+      expect(result1).not_to eq(result2)
+    end
+
+    it 'handles empty strings' do
+      result = described_class.hash_key('')
+      expect(result).to be >= 0
+      expect(result).to be < 100
+    end
+
+    it 'handles special characters' do
+      result = described_class.hash_key('user@example.com:flag-123')
+      expect(result).to be >= 0
+      expect(result).to be < 100
+    end
+
+    # Test known values to ensure consistency with JS implementation
+    it 'matches JavaScript implementation for known values' do
+      # These values should match the JavaScript implementation
+      # Testing the hash algorithm produces consistent results
+      result = described_class.hash_key('test')
+      expect(result).to be_a(Integer)
+      expect(result).to be >= 0
+      expect(result).to be < 100
+    end
+  end
+
+  describe '.get_nested_property' do
+    let(:obj) do
+      {
+        user: {
+          id: '123',
+          email: 'test@example.com',
+          profile: {
+            name: 'Test User'
+          }
+        },
+        request: {
+          ip: '192.168.1.1'
+        }
+      }
+    end
+
+    it 'retrieves top-level properties with symbol keys' do
+      result = described_class.get_nested_property(obj, 'user')
+      expect(result).to eq(obj[:user])
+    end
+
+    it 'retrieves nested properties with dot notation' do
+      result = described_class.get_nested_property(obj, 'user.id')
+      expect(result).to eq('123')
+    end
+
+    it 'retrieves deeply nested properties' do
+      result = described_class.get_nested_property(obj, 'user.profile.name')
+      expect(result).to eq('Test User')
+    end
+
+    it 'works with string keys in the hash' do
+      string_obj = {
+        'user' => {
+          'id' => '456'
+        }
+      }
+      result = described_class.get_nested_property(string_obj, 'user.id')
+      expect(result).to eq('456')
+    end
+
+    it 'returns nil for missing properties' do
+      result = described_class.get_nested_property(obj, 'user.missing')
+      expect(result).to be_nil
+    end
+
+    it 'returns nil for missing nested properties' do
+      result = described_class.get_nested_property(obj, 'user.profile.missing.deeply')
+      expect(result).to be_nil
+    end
+
+    it 'returns nil when obj is nil' do
+      result = described_class.get_nested_property(nil, 'user.id')
+      expect(result).to be_nil
+    end
+
+    it 'returns nil when path is nil' do
+      result = described_class.get_nested_property(obj, nil)
+      expect(result).to be_nil
+    end
+
+    it 'returns nil when path is empty' do
+      result = described_class.get_nested_property(obj, '')
+      expect(result).to be_nil
+    end
+
+    it 'handles mixed symbol and string keys' do
+      mixed_obj = {
+        user: {
+          'email' => 'test@example.com'
+        }
+      }
+      result = described_class.get_nested_property(mixed_obj, 'user.email')
+      expect(result).to eq('test@example.com')
+    end
+  end
+
+  describe '.compare_semver' do
+    it 'returns 0 for equal versions' do
+      expect(described_class.compare_semver('1.0.0', '1.0.0')).to eq(0)
+      expect(described_class.compare_semver('2.5.3', '2.5.3')).to eq(0)
+    end
+
+    it 'returns 1 when first version is greater' do
+      expect(described_class.compare_semver('2.0.0', '1.0.0')).to eq(1)
+      expect(described_class.compare_semver('1.2.0', '1.1.0')).to eq(1)
+      expect(described_class.compare_semver('1.0.2', '1.0.1')).to eq(1)
+    end
+
+    it 'returns -1 when first version is less' do
+      expect(described_class.compare_semver('1.0.0', '2.0.0')).to eq(-1)
+      expect(described_class.compare_semver('1.1.0', '1.2.0')).to eq(-1)
+      expect(described_class.compare_semver('1.0.1', '1.0.2')).to eq(-1)
+    end
+
+    it 'handles versions with different part counts' do
+      expect(described_class.compare_semver('1.0', '1.0.0')).to eq(0)
+      expect(described_class.compare_semver('1', '1.0.0')).to eq(0)
+      expect(described_class.compare_semver('2.0', '1.5.9')).to eq(1)
+    end
+
+    it 'handles missing version parts as zero' do
+      expect(described_class.compare_semver('1.2', '1.2.0')).to eq(0)
+      expect(described_class.compare_semver('1.2', '1.2.1')).to eq(-1)
+      expect(described_class.compare_semver('1.3', '1.2.9')).to eq(1)
+    end
+
+    it 'compares major versions correctly' do
+      expect(described_class.compare_semver('10.0.0', '9.0.0')).to eq(1)
+      expect(described_class.compare_semver('2.0.0', '10.0.0')).to eq(-1)
+    end
+
+    it 'compares minor versions correctly' do
+      expect(described_class.compare_semver('1.10.0', '1.9.0')).to eq(1)
+      expect(described_class.compare_semver('1.2.0', '1.10.0')).to eq(-1)
+    end
+
+    it 'compares patch versions correctly' do
+      expect(described_class.compare_semver('1.0.10', '1.0.9')).to eq(1)
+      expect(described_class.compare_semver('1.0.2', '1.0.10')).to eq(-1)
+    end
+  end
+
+  describe '.generate_jitter' do
+    it 'returns a value within the specified range' do
+      100.times do
+        result = described_class.generate_jitter(1500)
+        expect(result).to be >= 0
+        expect(result).to be <= 1500
+      end
+    end
+
+    it 'returns different values on multiple calls' do
+      results = 100.times.map { described_class.generate_jitter(1500) }
+      unique_results = results.uniq
+      # Should have some variety (not all the same)
+      expect(unique_results.length).to be > 1
+    end
+
+    it 'works with different max values' do
+      result = described_class.generate_jitter(5000)
+      expect(result).to be >= 0
+      expect(result).to be <= 5000
+    end
+
+    it 'handles zero max jitter' do
+      result = described_class.generate_jitter(0)
+      expect(result).to eq(0)
+    end
+  end
+
+  describe '.create_cache_key' do
+    it 'creates a key from flag and user id' do
+      context = { user: { id: '123' } }
+      result = described_class.create_cache_key('my-flag', context)
+      expect(result).to eq('my-flag:123')
+    end
+
+    it 'uses email if id is missing' do
+      context = { user: { email: 'test@example.com' } }
+      result = described_class.create_cache_key('my-flag', context)
+      expect(result).to eq('my-flag:test@example.com')
+    end
+
+    it "uses 'anonymous' if both id and email are missing" do
+      context = { user: {} }
+      result = described_class.create_cache_key('my-flag', context)
+      expect(result).to eq('my-flag:anonymous')
+    end
+
+    it "uses 'anonymous' if user is missing" do
+      context = {}
+      result = described_class.create_cache_key('my-flag', context)
+      expect(result).to eq('my-flag:anonymous')
+    end
+
+    it 'prefers id over email' do
+      context = { user: { id: '123', email: 'test@example.com' } }
+      result = described_class.create_cache_key('my-flag', context)
+      expect(result).to eq('my-flag:123')
+    end
+  end
+
+  describe '.evaluate_operator' do
+    describe 'equals operator' do
+      it 'returns true when values are equal (case-insensitive)' do
+        expect(described_class.evaluate_operator('test', 'equals', ['test'])).to be true
+        expect(described_class.evaluate_operator('Test', 'equals', ['test'])).to be true
+        expect(described_class.evaluate_operator('TEST', 'equals', ['test'])).to be true
+      end
+
+      it 'returns false when values are not equal' do
+        expect(described_class.evaluate_operator('test', 'equals', ['other'])).to be false
+      end
+
+      it 'handles numeric values' do
+        expect(described_class.evaluate_operator(123, 'equals', [123])).to be true
+        expect(described_class.evaluate_operator(123, 'equals', ['123'])).to be true
+      end
+    end
+
+    describe 'not_equals operator' do
+      it 'returns false when values are equal' do
+        expect(described_class.evaluate_operator('test', 'not_equals', ['test'])).to be false
+      end
+
+      it 'returns true when values are not equal' do
+        expect(described_class.evaluate_operator('test', 'not_equals', ['other'])).to be true
+      end
+
+      it 'returns true for nil values' do
+        expect(described_class.evaluate_operator(nil, 'not_equals', ['test'])).to be true
+      end
+    end
+
+    describe 'contains operator' do
+      it 'returns true when attribute contains value' do
+        expect(described_class.evaluate_operator('hello world', 'contains', ['world'])).to be true
+        expect(described_class.evaluate_operator('HELLO WORLD', 'contains', ['world'])).to be true
+      end
+
+      it 'returns false when attribute does not contain value' do
+        expect(described_class.evaluate_operator('hello world', 'contains', ['xyz'])).to be false
+      end
+    end
+
+    describe 'not_contains operator' do
+      it 'returns false when attribute contains value' do
+        expect(described_class.evaluate_operator('hello world', 'not_contains', ['world'])).to be false
+      end
+
+      it 'returns true when attribute does not contain value' do
+        expect(described_class.evaluate_operator('hello world', 'not_contains', ['xyz'])).to be true
+      end
+    end
+
+    describe 'starts_with operator' do
+      it 'returns true when attribute starts with value' do
+        expect(described_class.evaluate_operator('hello world', 'starts_with', ['hello'])).to be true
+        expect(described_class.evaluate_operator('HELLO WORLD', 'starts_with', ['hello'])).to be true
+      end
+
+      it 'returns false when attribute does not start with value' do
+        expect(described_class.evaluate_operator('hello world', 'starts_with', ['world'])).to be false
+      end
+    end
+
+    describe 'ends_with operator' do
+      it 'returns true when attribute ends with value' do
+        expect(described_class.evaluate_operator('hello world', 'ends_with', ['world'])).to be true
+        expect(described_class.evaluate_operator('HELLO WORLD', 'ends_with', ['world'])).to be true
+      end
+
+      it 'returns false when attribute does not end with value' do
+        expect(described_class.evaluate_operator('hello world', 'ends_with', ['hello'])).to be false
+      end
+    end
+
+    describe 'in operator' do
+      it 'returns true when attribute is in the list' do
+        expect(described_class.evaluate_operator('admin', 'in', %w[admin user guest])).to be true
+        expect(described_class.evaluate_operator('ADMIN', 'in', %w[admin user guest])).to be true
+      end
+
+      it 'returns false when attribute is not in the list' do
+        expect(described_class.evaluate_operator('superuser', 'in', %w[admin user guest])).to be false
+      end
+
+      it 'handles numeric values' do
+        expect(described_class.evaluate_operator(1, 'in', [1, 2, 3])).to be true
+        expect(described_class.evaluate_operator(4, 'in', [1, 2, 3])).to be false
+      end
+    end
+
+    describe 'not_in operator' do
+      it 'returns false when attribute is in the list' do
+        expect(described_class.evaluate_operator('admin', 'not_in', %w[admin user guest])).to be false
+      end
+
+      it 'returns true when attribute is not in the list' do
+        expect(described_class.evaluate_operator('superuser', 'not_in', %w[admin user guest])).to be true
+      end
+
+      it 'returns true for nil values' do
+        expect(described_class.evaluate_operator(nil, 'not_in', %w[admin user guest])).to be true
+      end
+    end
+
+    describe 'gt operator' do
+      it 'returns true when attribute is greater than value' do
+        expect(described_class.evaluate_operator(10, 'gt', [5])).to be true
+        expect(described_class.evaluate_operator(5.5, 'gt', [5])).to be true
+      end
+
+      it 'returns false when attribute is less than or equal to value' do
+        expect(described_class.evaluate_operator(5, 'gt', [10])).to be false
+        expect(described_class.evaluate_operator(5, 'gt', [5])).to be false
+      end
+
+      it 'handles string numeric values' do
+        expect(described_class.evaluate_operator('10', 'gt', ['5'])).to be true
+      end
+    end
+
+    describe 'gte operator' do
+      it 'returns true when attribute is greater than or equal to value' do
+        expect(described_class.evaluate_operator(10, 'gte', [5])).to be true
+        expect(described_class.evaluate_operator(5, 'gte', [5])).to be true
+      end
+
+      it 'returns false when attribute is less than value' do
+        expect(described_class.evaluate_operator(5, 'gte', [10])).to be false
+      end
+    end
+
+    describe 'lt operator' do
+      it 'returns true when attribute is less than value' do
+        expect(described_class.evaluate_operator(5, 'lt', [10])).to be true
+      end
+
+      it 'returns false when attribute is greater than or equal to value' do
+        expect(described_class.evaluate_operator(10, 'lt', [5])).to be false
+        expect(described_class.evaluate_operator(5, 'lt', [5])).to be false
+      end
+    end
+
+    describe 'lte operator' do
+      it 'returns true when attribute is less than or equal to value' do
+        expect(described_class.evaluate_operator(5, 'lte', [10])).to be true
+        expect(described_class.evaluate_operator(5, 'lte', [5])).to be true
+      end
+
+      it 'returns false when attribute is greater than value' do
+        expect(described_class.evaluate_operator(10, 'lte', [5])).to be false
+      end
+    end
+
+    describe 'between operator' do
+      it 'returns true when attribute is between min and max (inclusive)' do
+        expect(described_class.evaluate_operator(5, 'between', [1, 10])).to be true
+        expect(described_class.evaluate_operator(1, 'between', [1, 10])).to be true
+        expect(described_class.evaluate_operator(10, 'between', [1, 10])).to be true
+      end
+
+      it 'returns false when attribute is outside range' do
+        expect(described_class.evaluate_operator(0, 'between', [1, 10])).to be false
+        expect(described_class.evaluate_operator(11, 'between', [1, 10])).to be false
+      end
+
+      it 'returns false when condition values are insufficient' do
+        expect(described_class.evaluate_operator(5, 'between', [1])).to be false
+      end
+
+      it 'handles decimal values' do
+        expect(described_class.evaluate_operator(5.5, 'between', [5, 6])).to be true
+      end
+    end
+
+    describe 'regex operator' do
+      it 'returns true when attribute matches regex' do
+        expect(described_class.evaluate_operator('test123', 'regex', ['^test\\d+$'])).to be true
+        expect(described_class.evaluate_operator('user@example.com', 'regex', ['^[^@]+@[^@]+$'])).to be true
+      end
+
+      it 'returns false when attribute does not match regex' do
+        expect(described_class.evaluate_operator('test', 'regex', ['^\\d+$'])).to be false
+      end
+
+      it 'returns false for invalid regex' do
+        expect(described_class.evaluate_operator('test', 'regex', ['[invalid'])).to be false
+      end
+
+      it 'handles complex patterns' do
+        expect(described_class.evaluate_operator('192.168.1.1', 'regex', ['^\\d+\\.\\d+\\.\\d+\\.\\d+$'])).to be true
+      end
+    end
+
+    describe 'semver operators' do
+      describe 'semver_eq' do
+        it 'returns true for equal versions' do
+          expect(described_class.evaluate_operator('1.2.3', 'semver_eq', ['1.2.3'])).to be true
+        end
+
+        it 'returns false for different versions' do
+          expect(described_class.evaluate_operator('1.2.3', 'semver_eq', ['1.2.4'])).to be false
+        end
+      end
+
+      describe 'semver_gt' do
+        it 'returns true when attribute version is greater' do
+          expect(described_class.evaluate_operator('2.0.0', 'semver_gt', ['1.0.0'])).to be true
+          expect(described_class.evaluate_operator('1.1.0', 'semver_gt', ['1.0.0'])).to be true
+        end
+
+        it 'returns false when attribute version is less or equal' do
+          expect(described_class.evaluate_operator('1.0.0', 'semver_gt', ['2.0.0'])).to be false
+          expect(described_class.evaluate_operator('1.0.0', 'semver_gt', ['1.0.0'])).to be false
+        end
+      end
+
+      describe 'semver_gte' do
+        it 'returns true when attribute version is greater or equal' do
+          expect(described_class.evaluate_operator('2.0.0', 'semver_gte', ['1.0.0'])).to be true
+          expect(described_class.evaluate_operator('1.0.0', 'semver_gte', ['1.0.0'])).to be true
+        end
+
+        it 'returns false when attribute version is less' do
+          expect(described_class.evaluate_operator('1.0.0', 'semver_gte', ['2.0.0'])).to be false
+        end
+      end
+
+      describe 'semver_lt' do
+        it 'returns true when attribute version is less' do
+          expect(described_class.evaluate_operator('1.0.0', 'semver_lt', ['2.0.0'])).to be true
+        end
+
+        it 'returns false when attribute version is greater or equal' do
+          expect(described_class.evaluate_operator('2.0.0', 'semver_lt', ['1.0.0'])).to be false
+          expect(described_class.evaluate_operator('1.0.0', 'semver_lt', ['1.0.0'])).to be false
+        end
+      end
+
+      describe 'semver_lte' do
+        it 'returns true when attribute version is less or equal' do
+          expect(described_class.evaluate_operator('1.0.0', 'semver_lte', ['2.0.0'])).to be true
+          expect(described_class.evaluate_operator('1.0.0', 'semver_lte', ['1.0.0'])).to be true
+        end
+
+        it 'returns false when attribute version is greater' do
+          expect(described_class.evaluate_operator('2.0.0', 'semver_lte', ['1.0.0'])).to be false
+        end
+      end
+    end
+
+    describe 'nil attribute handling' do
+      it 'returns false for most operators when attribute is nil' do
+        expect(described_class.evaluate_operator(nil, 'equals', ['test'])).to be false
+        expect(described_class.evaluate_operator(nil, 'contains', ['test'])).to be false
+        expect(described_class.evaluate_operator(nil, 'in', ['test'])).to be false
+      end
+
+      it 'returns true for not_equals when attribute is nil' do
+        expect(described_class.evaluate_operator(nil, 'not_equals', ['test'])).to be true
+      end
+
+      it 'returns true for not_in when attribute is nil' do
+        expect(described_class.evaluate_operator(nil, 'not_in', ['test'])).to be true
+      end
+    end
+
+    describe 'unknown operator' do
+      it 'returns false and warns for unknown operator' do
+        expect do
+          result = described_class.evaluate_operator('test', 'unknown_op', ['value'])
+          expect(result).to be false
+        end.to output(/Unknown operator: unknown_op/).to_stderr
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: togglecraft
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- ToggleCraft
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.59'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.59'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.19'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.19'
+description: Real-time feature flags with SSE streaming, local evaluation, and smart
+  caching
+email:
+- support@togglecraft.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/togglecraft.rb
+- lib/togglecraft/cache.rb
+- lib/togglecraft/cache_adapters/memory_adapter.rb
+- lib/togglecraft/client.rb
+- lib/togglecraft/connection_pool.rb
+- lib/togglecraft/evaluator.rb
+- lib/togglecraft/shared_sse_connection.rb
+- lib/togglecraft/sse_connection.rb
+- lib/togglecraft/utils.rb
+- lib/togglecraft/version.rb
+- spec/spec_helper.rb
+- spec/togglecraft/cache/memory_adapter_spec.rb
+- spec/togglecraft/cache_spec.rb
+- spec/togglecraft/client_spec.rb
+- spec/togglecraft/connection_pool_spec.rb
+- spec/togglecraft/evaluator_spec.rb
+- spec/togglecraft/shared_sse_connection_spec.rb
+- spec/togglecraft/sse_connection_spec.rb
+- spec/togglecraft/utils_spec.rb
+homepage: https://github.com/togglecraft/ruby-sdk
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/togglecraft/ruby-sdk
+  source_code_uri: https://github.com/togglecraft/ruby-sdk
+  changelog_uri: https://github.com/togglecraft/ruby-sdk/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+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.6.7
+specification_version: 4
+summary: Ruby SDK for ToggleCraft feature flag management
+test_files: []