spellkit 0.1.0.pre.1 → 0.1.0

data/lib/spellkit/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SpellKit
-  VERSION = "0.1.0.pre.1"
+  VERSION = "0.1.0"
 end

data/lib/spellkit.rb

@@ -1,6 +1,7 @@
 require_relative "spellkit/version"
 require "uri"
 require "net/http"
+require "openssl"
 require "fileutils"
 
 begin
@@ -67,12 +68,16 @@ module SpellKit
       @default
     end
 
-    def suggest(word, max = 5)
-      default.suggest(word, max)
+    def suggestions(word, max = 5)
+      default.suggestions(word, max)
     end
 
-    def correct_if_unknown(word, guard: nil)
-      default.correct_if_unknown(word, guard: guard)
+    def correct?(word)
+      default.correct?(word)
+    end
+
+    def correct(word, guard: nil)
+      default.correct(word, guard: guard)
     end
 
     def correct_tokens(tokens, guard: nil)
@@ -93,14 +98,17 @@ end
 class SpellKit::Checker
   # Save original Rust methods
   alias_method :_rust_load!, :load!
-  alias_method :_rust_suggest, :suggest
-  alias_method :_rust_correct_if_unknown, :correct_if_unknown
+  alias_method :_rust_suggestions, :suggestions
+  alias_method :_rust_correct?, :correct?
+  alias_method :_rust_correct, :correct
   alias_method :_rust_correct_tokens, :correct_tokens
   alias_method :_rust_stats, :stats
   alias_method :_rust_healthcheck, :healthcheck
 
   def load!(dictionary: nil, protected_path: nil, protected_patterns: [],
-            edit_distance: 1, frequency_threshold: 10.0, **_options)
+            edit_distance: 1, frequency_threshold: 10.0,
+            skip_urls: false, skip_emails: false, skip_hostnames: false,
+            skip_code_patterns: false, skip_numbers: false, **_options)
 
     # Validate dictionary parameter
     raise SpellKit::InvalidArgumentError, "dictionary parameter is required" if dictionary.nil?
@@ -125,6 +133,31 @@ class SpellKit::Checker
       raise SpellKit::InvalidArgumentError, "protected_patterns must be an Array"
     end
 
+    # Validate frequency_threshold
+    unless frequency_threshold.is_a?(Numeric)
+      raise SpellKit::InvalidArgumentError, "frequency_threshold must be a number, got: #{frequency_threshold.class}"
+    end
+
+    unless frequency_threshold.finite?
+      raise SpellKit::InvalidArgumentError, "frequency_threshold must be finite (got NaN or Infinity)"
+    end
+
+    if frequency_threshold < 0
+      raise SpellKit::InvalidArgumentError, "frequency_threshold must be non-negative, got: #{frequency_threshold}"
+    end
+
+    # Build skip patterns from convenience flags
+    skip_patterns = build_skip_patterns(
+      skip_urls: skip_urls,
+      skip_emails: skip_emails,
+      skip_hostnames: skip_hostnames,
+      skip_code_patterns: skip_code_patterns,
+      skip_numbers: skip_numbers
+    )
+
+    # Merge skip patterns with user-provided patterns
+    all_patterns = skip_patterns + protected_patterns
+
     config = {
       "dictionary_path" => dictionary_path,
       "edit_distance" => edit_distance,
@@ -133,37 +166,57 @@ class SpellKit::Checker
 
     config["protected_path"] = protected_path.to_s if protected_path
 
-    # Convert Ruby Regex objects to strings for Rust
-    if protected_patterns.any?
-      pattern_strings = protected_patterns.map do |pattern|
+    # Convert Ruby Regex objects to hashes with flags for Rust
+    if all_patterns.any?
+      pattern_objects = all_patterns.map do |pattern|
         if pattern.is_a?(Regexp)
-          pattern.source
+          # Extract flags from Regexp.options bitmask
+          options = pattern.options
+          {
+            "source" => pattern.source,
+            "case_insensitive" => (options & Regexp::IGNORECASE) != 0,
+            "multiline" => (options & Regexp::MULTILINE) != 0,
+            "extended" => (options & Regexp::EXTENDED) != 0
+          }
         elsif pattern.is_a?(String)
-          pattern
+          # Plain strings default to case-sensitive
+          {
+            "source" => pattern,
+            "case_insensitive" => false,
+            "multiline" => false,
+            "extended" => false
+          }
         else
           raise SpellKit::InvalidArgumentError, "protected_patterns must contain Regexp or String objects"
         end
       end
-      config["protected_patterns"] = pattern_strings
+      config["protected_patterns"] = pattern_objects
     end
 
     _rust_load!(config)
     self
   end
 
-  def suggest(word, max = 5)
+  def suggestions(word, max = 5)
     raise SpellKit::InvalidArgumentError, "word cannot be nil" if word.nil?
     raise SpellKit::InvalidArgumentError, "word cannot be empty" if word.to_s.empty?
 
-    _rust_suggest(word, max)
+    _rust_suggestions(word, max)
   end
 
-  def correct_if_unknown(word, guard: nil)
+  def correct?(word)
+    raise SpellKit::InvalidArgumentError, "word cannot be nil" if word.nil?
+    raise SpellKit::InvalidArgumentError, "word cannot be empty" if word.to_s.empty?
+
+    _rust_correct?(word)
+  end
+
+  def correct(word, guard: nil)
     raise SpellKit::InvalidArgumentError, "word cannot be nil" if word.nil?
     raise SpellKit::InvalidArgumentError, "word cannot be empty" if word.to_s.empty?
 
     use_guard = guard == :domain
-    _rust_correct_if_unknown(word, use_guard)
+    _rust_correct(word, use_guard)
   end
 
   def correct_tokens(tokens, guard: nil)
@@ -183,6 +236,61 @@ class SpellKit::Checker
 
   private
 
+  def build_skip_patterns(skip_urls:, skip_emails:, skip_hostnames:, skip_code_patterns:, skip_numbers:)
+    patterns = []
+
+    # Priority 1: URLs, Emails, Hostnames
+    if skip_urls
+      # Match http:// or https:// URLs
+      patterns << /^https?:\/\/[^\s]+$/i
+      # Match www. URLs
+      patterns << /^www\.[^\s]+$/i
+    end
+
+    if skip_emails
+      # Match email addresses: user@domain.com, user+tag@domain.co.uk
+      patterns << /^[\w.+-]+@[\w.-]+\.\w+$/i
+    end
+
+    if skip_hostnames
+      # Match hostnames: example.com, sub.example.com, my-site.co.uk
+      # Must have at least one dot and valid TLD
+      patterns << /^[a-z0-9]([a-z0-9-]*[a-z0-9])?(\.[a-z0-9]([a-z0-9-]*[a-z0-9])?)+$/i
+    end
+
+    # Priority 2: Code patterns
+    if skip_code_patterns
+      # Match camelCase: starts lowercase, has uppercase (arrayMap, getElementById)
+      patterns << /^[a-z]+[A-Z][a-zA-Z0-9]*$/
+      # Match PascalCase: starts uppercase, has mixed case (ArrayList, MyClass)
+      patterns << /^[A-Z][a-z]+[A-Z][a-zA-Z0-9]*$/
+      # Match snake_case: lowercase with underscores (my_function, API_KEY)
+      patterns << /^[a-z]+_[a-z0-9_]+$/i
+      # Match SCREAMING_SNAKE_CASE: uppercase with underscores
+      patterns << /^[A-Z]+_[A-Z0-9_]+$/
+      # Match dotted.paths: identifier.identifier (Array.map, config.yml)
+      patterns << /^[a-zA-Z_][a-zA-Z0-9_]*\.[a-zA-Z_][a-zA-Z0-9_.]*$/
+    end
+
+    # Priority 3: Numeric patterns
+    if skip_numbers
+      # Match version numbers: 1.0, 1.2.3, 1.2.3.4
+      patterns << /^\d+\.\d+(\.\d+)?(\.\d+)?$/
+      # Match hash/IDs: #123, #4567
+      patterns << /^#\d+$/
+      # Match measurements with common units
+      # Weight: kg, g, mg, lb, oz
+      # Distance: km, m, cm, mm, mi, ft, in
+      # Data: gb, mb, kb, tb, pb
+      # Screen: px, pt, em, rem
+      patterns << /^\d+(\.\d+)?(kg|g|mg|lb|oz|km|m|cm|mm|mi|ft|in|gb|mb|kb|tb|pb|px|pt|em|rem)$/i
+      # Match standalone numbers at start of word (5kg, 123abc)
+      patterns << /^\d/
+    end
+
+    patterns
+  end
+
   def download_dictionary(url)
     require "digest"
 
@@ -197,20 +305,59 @@ class SpellKit::Checker
     # Return cached file if it exists
     return cache_file if File.exist?(cache_file)
 
-    # Download dictionary
-    uri = URI.parse(url)
-    response = Net::HTTP.get_response(uri)
-
-    unless response.is_a?(Net::HTTPSuccess)
-      raise SpellKit::DownloadError, "Failed to download dictionary from #{url}: #{response.code} #{response.message}"
-    end
+    # Download dictionary with timeout and redirect handling
+    body = fetch_with_redirects(url, max_redirects: 5, open_timeout: 10, read_timeout: 30)
 
     # Write to cache
-    File.write(cache_file, response.body)
+    File.write(cache_file, body)
     cache_file
   rescue URI::InvalidURIError => e
     raise SpellKit::InvalidArgumentError, "Invalid URL: #{url} (#{e.message})"
+  rescue Timeout::Error => e
+    raise SpellKit::DownloadError, "Download timed out: #{url} (#{e.message})"
   rescue StandardError => e
     raise SpellKit::DownloadError, "Failed to download dictionary: #{e.message}"
   end
+
+  def fetch_with_redirects(url, max_redirects: 5, open_timeout: 10, read_timeout: 30, redirect_count: 0)
+    raise SpellKit::DownloadError, "Too many redirects (limit: #{max_redirects})" if redirect_count > max_redirects
+
+    uri = URI.parse(url)
+
+    # Configure HTTP client with timeouts and SSL verification
+    Net::HTTP.start(uri.host, uri.port,
+      use_ssl: uri.scheme == "https",
+      open_timeout: open_timeout,
+      read_timeout: read_timeout,
+      verify_mode: OpenSSL::SSL::VERIFY_PEER) do |http|
+      request = Net::HTTP::Get.new(uri.request_uri)
+      response = http.request(request)
+
+      case response
+      when Net::HTTPSuccess
+        response.body
+      when Net::HTTPRedirection
+        # Follow redirect
+        location = response["location"]
+        raise SpellKit::DownloadError, "Redirect missing Location header" if location.nil? || location.empty?
+
+        # Handle relative redirects
+        redirect_uri = URI.parse(location)
+        redirect_url = redirect_uri.relative? ? URI.join(url, location).to_s : location
+
+        fetch_with_redirects(redirect_url, max_redirects: max_redirects, open_timeout: open_timeout,
+          read_timeout: read_timeout, redirect_count: redirect_count + 1)
+      else
+        raise SpellKit::DownloadError, "HTTP #{response.code}: #{response.message} (#{url})"
+      end
+    end
+  rescue Net::OpenTimeout => e
+    raise Timeout::Error, "Connection timeout after #{open_timeout}s: #{url}"
+  rescue Net::ReadTimeout => e
+    raise Timeout::Error, "Read timeout after #{read_timeout}s: #{url}"
+  rescue SocketError => e
+    raise SpellKit::DownloadError, "Network error: #{e.message} (#{url})"
+  rescue OpenSSL::SSL::SSLError => e
+    raise SpellKit::DownloadError, "SSL verification failed: #{e.message} (#{url})"
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spellkit
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Chris Petersen
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-09-26 00:00:00.000000000 Z
+date: 2025-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rb_sys
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -53,19 +67,89 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: rake-compiler
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: standard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: irb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: benchmark-ips
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ffi-aspell
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A Ruby gem that provides fast typo correction using SymSpell algorithm,
   with domain-specific term protection
 email:
@@ -75,7 +159,6 @@ extensions:
 - ext/spellkit/extconf.rb
 extra_rdoc_files: []
 files:
-- LICENSE
 - README.md
 - ext/spellkit/Cargo.lock
 - ext/spellkit/Cargo.toml
@@ -87,11 +170,19 @@ files:
 - ext/spellkit/target/debug/build/clang-sys-051521a65ca8f402/out/dynamic.rs
 - ext/spellkit/target/debug/build/clang-sys-051521a65ca8f402/out/macros.rs
 - ext/spellkit/target/debug/build/rb-sys-4cf7db3819c4a6ed/out/bindings-0.9.117-mri-arm64-darwin24-3.3.0.rs
+- ext/spellkit/target/debug/build/rb-sys-ead65721880de65e/out/bindings-0.9.117-mri-arm64-darwin24-3.3.0.rs
 - ext/spellkit/target/debug/build/serde-b1b39c86cf577219/out/private.rs
 - ext/spellkit/target/debug/build/serde_core-7a7752261f0e4007/out/private.rs
+- ext/spellkit/target/debug/incremental/spellkit-07yduakb6espe/s-hbic3f250f-1cel1lt.lock
 - ext/spellkit/target/debug/incremental/spellkit-10n1yon0n2c8v/s-hbha7isu2i-02ly2uq.lock
+- ext/spellkit/target/debug/incremental/spellkit-1d3zzknqc98bj/s-hbic3f250l-011iykk.lock
+- ext/spellkit/target/debug/incremental/spellkit-1pt6om2w642b5/s-hbihepi6zy-1r3p88g.lock
 - ext/spellkit/target/debug/incremental/spellkit-2jusczkp089xp/s-hbhcyx6yob-0pqrnyt.lock
 - ext/spellkit/target/debug/incremental/spellkit-39nm03wp54lxw/s-hbhcyx6ynq-08lhwc0.lock
+- ext/spellkit/target/release/build/clang-sys-523e86284ef4dd76/out/common.rs
+- ext/spellkit/target/release/build/clang-sys-523e86284ef4dd76/out/dynamic.rs
+- ext/spellkit/target/release/build/clang-sys-523e86284ef4dd76/out/macros.rs
+- ext/spellkit/target/release/build/rb-sys-7d03ffe964952311/out/bindings-0.9.117-mri-arm64-darwin24-3.3.0.rs
 - lib/spellkit.rb
 - lib/spellkit/version.rb
 homepage: https://github.com/scientist-labs/spellkit

data/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2025 Chris Petersen
-
-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.