jev-feels 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 125dde58282251c7692d030e90352e098cf1785bc38904cf6021098d073d2f8a
-  data.tar.gz: 6bdf7fb784623b94cde049148294a1513e59207ccde0fd683869bbb4cc639a6d
+  metadata.gz: e06314aa51799f9434268858022138a8a871b4f58332907b4be0f5d187885073
+  data.tar.gz: 8e5e28527de0e411f38ca91b660cb6a43c77a955af2a0780227c9401d4fdfe35
 SHA512:
-  metadata.gz: 2b5a17cbde5d54178e39eed6600fdff431f5fdfa0515af09f79f4711eb19b67148a87e669a973755d2afa9546c2fcd5e6e14e15b29d1ddc4908834bc24ca4570
-  data.tar.gz: fb31b5c3f4fb3d90204cbfa815a5bf3aff537eb8611645f5099c79b775f1fd6d8f6427dc4ea603a8b7f670278aae61fe7b7e6e009e7136528fd75ab2149c0c82
+  metadata.gz: 11ff5c82f81642c4e60c1c39f4567de4b3d4e4a7c0ab6bd31a4a19be9cca47b5e2642f1b1388b2cc507ab45b563d02e7ea09767f489954ef1b3bb3d57659a798
+  data.tar.gz: 184c045587028d305a7fa8310c298687998981b655ded9e71e8c7990cb30bfeeaecac59bed11940ef3903bde5dfd49eb99a78c37e0c7e3a83f5a8274e8692589

data/README.md

@@ -27,7 +27,7 @@ end
 
 ## Ruby on Rails
 
-Gemfile, initializer, then an ordinary condition. Bundler loads the gem — no extra `require` unless you want sugar on `String`.
+Configure once, declare predicates on the model, ask the record:
 
 ```ruby
 # Gemfile
@@ -39,41 +39,22 @@ gem "jev-feels"
 Jev.configure do |config|
   config.api_key = ENV.fetch("JEV_API_KEY")
 end
-
-Jev.define :urgent, "Requires immediate attention or action"
-Jev.define SupportEmail, :urgent, "Outage, customers cannot sign in"
-Jev.define Comment, :urgent, "Legal takedown or self-harm"
 ```
 
 ```ruby
 class SupportEmail < ApplicationRecord
-  def urgent?
-    Jev.feels?(body, SupportEmail, :urgent)
-  end
-end
-```
+  include Jev::Model
 
-To use `#feels?` on strings across the app, require the String extension in the initializer:
-
-```ruby
-# config/initializers/jev.rb
-require "jev-feels/string"
-
-Jev.configure do |config|
-  config.api_key = ENV.fetch("JEV_API_KEY")
+  feels :body, :urgent, "Outage, customers cannot sign in"
 end
 
-Jev.define :urgent, "Requires immediate attention or action"
-Jev.define SupportEmail, :urgent, "Outage, customers cannot sign in"
+email.feels?(:urgent)
+email.feels(:urgent)
 ```
 
-```ruby
-class SupportEmail < ApplicationRecord
-  def urgent?
-    body.feels?(SupportEmail, :urgent)
-  end
-end
-```
+The class is the scope, the first argument is the field. No model name, no `email.body.feels?`.
+
+String sugar is still opt-in (`using Jev::Feels` or `require "jev-feels/string"`) if you want `body.feels?(:urgent)` on a raw string.
 
 ## String sugar
 
@@ -134,10 +115,10 @@ Jev.define Comment, :urgent, "Legal takedown or self-harm"
 Jev.definition(:urgent)
 Jev.definition(Email, :urgent)
 Jev.definitions
-Jev.definitions(Email)
+Jev.definitions(Comment)
 ```
 
-`define` replaces an existing name in that scope. `Jev.feels?(text, Email, :urgent)` uses the Email definition, then falls back to the global `:urgent` if Email has none. `definitions` / `definitions(Email)` return frozen copies.
+`define` replaces an existing name in that scope. Scopes are stored by class name, so `Email`, `"Email"` and `:Email` are the same key. `include Jev::Model` plus `feels :body, :urgent, "..."` does the same define and remembers the field. `Jev.feels?(text, Email, :urgent)` uses Email's definition, then a superclass, then the global `:urgent`. `definitions` returns a frozen copy.
 
 ## Configuration
 

data/context7.json

@@ -1,6 +1,6 @@
 {
   "$schema": "https://context7.com/schema/context7.json",
   "projectTitle": "jev-feels",
-  "description": "Ruby-like semantic text predicates via Jev. Jev.feels?(:urgent) is an ordinary condition, not an SDK session.",
+  "description": "Ruby-like semantic text predicates via Jev. Jev.feels?(:urgent) and model#feels?(:urgent) are ordinary conditions, not an SDK session.",
   "excludeFolders": ["spec"]
 }

data/lib/jev/model.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Jev
+  module Model
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def inherited(subclass)
+        super
+        subclass.extend ClassMethods
+      end
+
+      def feels(attribute, name, description)
+        raise ArgumentError, "attribute must be a Symbol" unless attribute.is_a?(Symbol)
+
+        Jev.define(self, name, description)
+        (@jev_feels_attributes ||= {})[name.to_sym] = attribute
+      end
+
+      def jev_feels_attribute(name)
+        current = self
+        while current && current != Object
+          found = current.instance_variable_get(:@jev_feels_attributes)&.[](name)
+          return found if found
+
+          current = current.superclass
+        end
+      end
+    end
+
+    def feels(predicate)
+      Jev.feels(jev_text_for(predicate), self.class, predicate)
+    end
+
+    def feels?(predicate, threshold: Jev.configuration.threshold)
+      Jev.feels?(jev_text_for(predicate), self.class, predicate, threshold: threshold)
+    end
+
+    private
+
+    def jev_text_for(predicate)
+      attribute = self.class.jev_feels_attribute(predicate.to_sym) || raise(
+        UndefinedDefinition, "Undefined Jev definition: #{predicate.inspect} for #{self.class}"
+      )
+
+      public_send(attribute).to_s
+    end
+  end
+end

data/lib/jev/registry.rb

@@ -10,29 +10,74 @@ module Jev
     def define(scope, name, description)
       key = name.to_sym
       value = description.to_s.dup.freeze
+      scope_key = storage_key(scope)
       @mutex.synchronize do
-        (@definitions[scope] ||= {})[key] = value
+        (@definitions[scope_key] ||= {})[key] = value
       end
       value
     end
 
-    def fetch(name, scope: nil, fallback: true)
+    def fetch(name, scope: nil, fallback: true, inherit: true)
       key = name.to_sym
       @mutex.synchronize do
-        scoped = @definitions.dig(scope, key) if scope
-        return scoped if scoped
-        return unless fallback || scope.nil?
+        return @definitions.dig(nil, key) if scope.nil?
 
-        @definitions.dig(nil, key)
+        lookup_keys(scope, inherit: inherit).each do |scope_key|
+          found = @definitions.dig(scope_key, key)
+          return found if found
+        end
+        return @definitions.dig(nil, key) if fallback
+
+        nil
       end
     end
 
     def all(scope = nil)
-      @mutex.synchronize { (@definitions[scope] || {}).dup.freeze }
+      @mutex.synchronize { (@definitions[storage_key(scope)] || {}).dup.freeze }
     end
 
     def reset!
       @mutex.synchronize { @definitions.clear }
     end
+
+    private
+
+    def storage_key(scope)
+      return if scope.nil?
+
+      key =
+        case scope
+        when String, Symbol then scope.to_s
+        when Module then scope.name || scope
+        else raise ArgumentError, "scope must be a Module, String, or Symbol"
+        end
+      raise ArgumentError, "scope must be a non-empty String" if key.is_a?(String) && key.empty?
+
+      key
+    end
+
+    def lookup_keys(scope, inherit:)
+      keys = [storage_key(scope)]
+      return keys unless inherit
+
+      klass = scope.is_a?(Class) ? scope : constantize(scope)
+      return keys unless klass.is_a?(Class)
+
+      current = klass.superclass
+      while current && current != Object
+        keys << (current.name || current)
+        current = current.superclass
+      end
+      keys.uniq
+    end
+
+    def constantize(name)
+      name = name.to_s if name.is_a?(Symbol)
+      return unless name.is_a?(String)
+
+      name.split("::").reduce(Object) { |mod, part| mod.const_get(part, false) }
+    rescue NameError
+      nil
+    end
   end
 end

data/lib/jev/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Jev
-  VERSION = "0.2.0"
+  VERSION = "1.0.0"
 end

data/lib/jev.rb

@@ -7,6 +7,7 @@ require_relative "jev/registry"
 require_relative "jev/transport"
 require_relative "jev/client"
 require_relative "jev/feels"
+require_relative "jev/model"
 
 module Jev
   class << self
@@ -22,30 +23,26 @@ module Jev
     end
 
     def define(scope_or_name, name_or_description, description = nil)
-      if scope_or_name.is_a?(Module)
-        raise ArgumentError, "description is required" if description.nil?
-
-        registry.define(scope_or_name, name_or_description, description)
-      else
-        raise ArgumentError, "wrong number of arguments (given 3, expected 2)" unless description.nil?
+      if description.nil?
+        if scope_or_name.is_a?(Module) || name_or_description.is_a?(Symbol)
+          raise ArgumentError, "description is required"
+        end
 
         registry.define(nil, scope_or_name, name_or_description)
+      else
+        registry.define(scope_or_name, name_or_description, description)
       end
     end
 
     def definition(scope_or_name, name = nil)
       if name.nil?
-        registry.fetch(scope_or_name, scope: nil, fallback: false)
+        registry.fetch(scope_or_name, scope: nil, fallback: false, inherit: false)
       else
-        raise ArgumentError, "scope must be a Module" unless scope_or_name.is_a?(Module)
-
-        registry.fetch(name, scope: scope_or_name, fallback: false)
+        registry.fetch(name, scope: scope_or_name, fallback: false, inherit: false)
       end
     end
 
     def definitions(scope = nil)
-      raise ArgumentError, "scope must be a Module" unless scope.nil? || scope.is_a?(Module)
-
       registry.all(scope)
     end
 
@@ -86,11 +83,15 @@ module Jev
 
     def unpack_predicate(scope_or_predicate, predicate)
       return [nil, scope_or_predicate] if predicate.nil?
-      raise ArgumentError, "scope must be a Module" unless scope_or_predicate.is_a?(Module)
+      raise ArgumentError, "scope must be a Module, String, or Symbol" unless scoped?(scope_or_predicate)
 
       [scope_or_predicate, predicate]
     end
 
+    def scoped?(value)
+      value.is_a?(Module) || value.is_a?(String) || value.is_a?(Symbol)
+    end
+
     def resolve(predicate, scope: nil)
       case predicate
       when Symbol

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jev-feels
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Maxim Veysgeym
@@ -31,6 +31,7 @@ files:
 - lib/jev/configuration.rb
 - lib/jev/errors.rb
 - lib/jev/feels.rb
+- lib/jev/model.rb
 - lib/jev/registry.rb
 - lib/jev/transport.rb
 - lib/jev/version.rb
@@ -40,7 +41,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/Qew7/jev-feels
   source_code_uri: https://github.com/Qew7/jev-feels
-  changelog_uri: https://github.com/Qew7/jev-feels/blob/main/README.md
+  changelog_uri: https://github.com/Qew7/jev-feels/blob/master/README.md
   allowed_push_host: https://rubygems.org
 post_install_message:
 rdoc_options: []