jev-feels 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb1c944edfc8044a07d64239c6452cf8717eee7a2878777b010ce06c7e328794
-  data.tar.gz: 4c4092c5de15890bb9897934dffe82c515a236e441444caf016e282d20046060
+  metadata.gz: 125dde58282251c7692d030e90352e098cf1785bc38904cf6021098d073d2f8a
+  data.tar.gz: 6bdf7fb784623b94cde049148294a1513e59207ccde0fd683869bbb4cc639a6d
 SHA512:
-  metadata.gz: c01170a2578338e6d8359399873593357c7896a2fa536eca538edd82830925d597e0bf6a6b5ffddb2fce804e9c974be6fe9a7eb7b62109d4078987f53743de75
-  data.tar.gz: 41919c36db8eb4497f57acac8ee0c02bcca2f8cb5e7a5bf7b347dadda62253e80a7b5a20274f5db199ea5642e5eb98c82909ac8b9546920a336bc9e5c54d2e8e
+  metadata.gz: 2b5a17cbde5d54178e39eed6600fdff431f5fdfa0515af09f79f4711eb19b67148a87e669a973755d2afa9546c2fcd5e6e14e15b29d1ddc4908834bc24ca4570
+  data.tar.gz: fb31b5c3f4fb3d90204cbfa815a5bf3aff537eb8611645f5099c79b775f1fd6d8f6427dc4ea603a8b7f670278aae61fe7b7e6e009e7136528fd75ab2149c0c82

data/README.md

@@ -25,6 +25,56 @@ if Jev.feels?(email, :urgent)
 end
 ```
 
+## Ruby on Rails
+
+Gemfile, initializer, then an ordinary condition. Bundler loads the gem — no extra `require` unless you want sugar on `String`.
+
+```ruby
+# Gemfile
+gem "jev-feels"
+```
+
+```ruby
+# config/initializers/jev.rb
+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
+```
+
+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")
+end
+
+Jev.define :urgent, "Requires immediate attention or action"
+Jev.define SupportEmail, :urgent, "Outage, customers cannot sign in"
+```
+
+```ruby
+class SupportEmail < ApplicationRecord
+  def urgent?
+    body.feels?(SupportEmail, :urgent)
+  end
+end
+```
+
 ## String sugar
 
 `require "feels"` does not change `String`. Opt in with a refinement:
@@ -39,6 +89,7 @@ Or, if you really want a global patch:
 
 ```ruby
 require "feels/string"
+# or: require "jev-feels/string"
 
 email.feels?(:urgent)
 ```
@@ -77,11 +128,16 @@ Jev.define :urgent, "Requires immediate attention or action"
 Jev.define :spam, "Unsolicited or unwanted promotional content"
 Jev.define :angry, "Expresses anger or hostility"
 
+Jev.define Email, :urgent, "Outage, customers cannot sign in"
+Jev.define Comment, :urgent, "Legal takedown or self-harm"
+
 Jev.definition(:urgent)
+Jev.definition(Email, :urgent)
 Jev.definitions
+Jev.definitions(Email)
 ```
 
-`define` replaces an existing name. `definitions` returns a frozen copy of the registry.
+`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.
 
 ## Configuration
 

data/lib/jev/registry.rb

@@ -7,19 +7,28 @@ module Jev
       @definitions = {}
     end
 
-    def define(name, description)
+    def define(scope, name, description)
       key = name.to_sym
       value = description.to_s.dup.freeze
-      @mutex.synchronize { @definitions[key] = value }
+      @mutex.synchronize do
+        (@definitions[scope] ||= {})[key] = value
+      end
       value
     end
 
-    def fetch(name)
-      @mutex.synchronize { @definitions[name.to_sym] }
+    def fetch(name, scope: nil, fallback: true)
+      key = name.to_sym
+      @mutex.synchronize do
+        scoped = @definitions.dig(scope, key) if scope
+        return scoped if scoped
+        return unless fallback || scope.nil?
+
+        @definitions.dig(nil, key)
+      end
     end
 
-    def all
-      @mutex.synchronize { @definitions.dup.freeze }
+    def all(scope = nil)
+      @mutex.synchronize { (@definitions[scope] || {}).dup.freeze }
     end
 
     def reset!

data/lib/jev/version.rb

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

data/lib/jev-feels/string.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "feels/string"

data/lib/jev.rb

@@ -21,28 +21,45 @@ module Jev
       @configuration = Configuration.new
     end
 
-    def define(name, description)
-      registry.define(name, description)
+    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?
+
+        registry.define(nil, scope_or_name, name_or_description)
+      end
     end
 
-    def definition(name)
-      registry.fetch(name)
+    def definition(scope_or_name, name = nil)
+      if name.nil?
+        registry.fetch(scope_or_name, scope: nil, fallback: 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)
+      end
     end
 
-    def definitions
-      registry.all
+    def definitions(scope = nil)
+      raise ArgumentError, "scope must be a Module" unless scope.nil? || scope.is_a?(Module)
+
+      registry.all(scope)
     end
 
     def reset_definitions!
       registry.reset!
     end
 
-    def feels(text, predicate)
-      Client.new(configuration).probability(coerce_text(text), resolve(predicate))
+    def feels(text, scope_or_predicate, predicate = nil)
+      scope, predicate = unpack_predicate(scope_or_predicate, predicate)
+      Client.new(configuration).probability(coerce_text(text), resolve(predicate, scope: scope))
     end
 
-    def feels?(text, predicate, threshold: configuration.threshold)
-      feels(text, predicate) >= normalize_threshold(threshold)
+    def feels?(text, scope_or_predicate, predicate = nil, threshold: configuration.threshold)
+      feels(text, scope_or_predicate, predicate) >= normalize_threshold(threshold)
     end
 
     def normalize_threshold(value)
@@ -67,17 +84,32 @@ module Jev
       text
     end
 
-    def resolve(predicate)
+    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)
+
+      [scope_or_predicate, predicate]
+    end
+
+    def resolve(predicate, scope: nil)
       case predicate
       when Symbol
-        definition(predicate) ||
-          raise(UndefinedDefinition, "Undefined Jev definition: #{predicate.inspect}")
+        registry.fetch(predicate, scope: scope) ||
+          raise(UndefinedDefinition, undefined_message(predicate, scope))
       when String
         predicate
       else
         raise ArgumentError, "predicate must be a Symbol or String"
       end
     end
+
+    def undefined_message(predicate, scope)
+      if scope
+        "Undefined Jev definition: #{predicate.inspect} for #{scope}"
+      else
+        "Undefined Jev definition: #{predicate.inspect}"
+      end
+    end
   end
 
   reset_configuration!

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jev-feels
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Maxim Veysgeym
@@ -25,6 +25,7 @@ files:
 - lib/feels.rb
 - lib/feels/string.rb
 - lib/jev-feels.rb
+- lib/jev-feels/string.rb
 - lib/jev.rb
 - lib/jev/client.rb
 - lib/jev/configuration.rb