smart_kv 0.2.7 → 0.2.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a40cd8eb22b67d869043b25fd77f73700f21c40dd0302cfc6d59d436fd89027f
-  data.tar.gz: faca0c5c75a0437de06f2e8a7eddd64097578b49187a46f0aecc4abfcf350c26
+  metadata.gz: 2afa3abc6fd5ba511ca89207c137cdb000db8951a9ee102f60436eddc7c93e1f
+  data.tar.gz: b8afd1a1fc115af8bccd6ce4b78396eb38beb83f245ed1716e9d80dc25284ba8
 SHA512:
-  metadata.gz: d4c7ee93525e01eb972ded20303bdb252897c009fbb6e0901d16e26481a7d859e8884b6f6cb44b51ea5569bb4ef8709cbfff05d1aaefbf2f188a1a898fd07bb2
-  data.tar.gz: 0fb4bce5f669b7afb31b5430e6aeb69b768b1e5acce875a9249976162c11a716490893aea011a669259344684a8730f06695474724877bc702681c52d0db545b
+  metadata.gz: 76915e48518766aece378cfb2c9bb293f5a8001055b3606f7c415a49571ec2c27efb063a8c8d546c589927050a008b1d3bc96b576016731e34ceaeca7fdf1198
+  data.tar.gz: f5e2f791d15a128d681a302ad6f49b2bf7b37a876eaa8fcf51b2170d33899ef386c4946a13627d1c74ba301f67851c23cf34be139f41cfbff6b658c60baba769

data/README.md

@@ -41,7 +41,7 @@ So, when you do this `d.change(hour: 1, minute: 5)`, it will yell:
 KeyError: unrecognized key: :minute in ChangeOptions
 ```
 
-Well, this is better. But, how do you know all the right options?  
+That's better. But, how do you know all the right options?  
 Type: `ChangeOptions.keys`
 
 
@@ -102,6 +102,23 @@ c.abcd #=> 123
 ```
 
 
+### Get suggestions
+
+When you make typo when writing a key of an options, you can get suggestions.
+
+```ruby
+class LanguageScore < SmartKv
+  required :ruby
+  optional :rust, :kotlin, :elixir
+end
+
+LanguageScore.check({ruby: 100, korting: 90})
+
+# SmartKv::KeyError: unrecognized key: :korting in LanguageScore.
+# Did you mean?  :kotlin
+```
+
+
 ### Not using it for options or configs?
 
 You can choose not to use it for options or configs. Maybe for strict request body keys?
@@ -115,6 +132,11 @@ end
 request.set_form_data(PostBody.check({app_key: "abc", secret_key: "def"}))
 ```
 
+### Alternative
+
+One close alternative that is quite similar in objective is probably
+[dry-schema](https://github.com/dry-rb/dry-schema).
+
 
 ## Installation
 

data/lib/smart_kv.rb

@@ -1,11 +1,11 @@
 require_relative "smart_kv/version"
-require_relative "smart_kv/check"
-require_relative "smart_kv/meat"
+require_relative "smart_kv/helper"
+require_relative "smart_kv/core"
 
 class SmartKv
-  if Check.has_did_you_mean_key_error?
+  if Helper.has_did_you_mean_key_error?
     require_relative "smart_kv/did_you_mean"
   end
 
-  extend Meat
+  extend Core
 end

data/lib/smart_kv/{meat.rb → core.rb}

@@ -1,10 +1,9 @@
+require 'set'
 require_relative "errors"
-require_relative "convert"
+require_relative "helper"
 
-module SmartKv::Meat
-  # The meat of the gem
-
-  include SmartKv::Convert
+module SmartKv::Core
+  include SmartKv::Helper
 
   def required(*args)
     init_required
@@ -19,7 +18,7 @@ module SmartKv::Meat
   end
 
   def init_required
-    @required ||= superclass == SmartKv ? Set.new : superclass.required.dup
+    @required ||= superclass == SmartKv ? ::Set.new : superclass.required.dup
   end
 
   def optional(*args)
@@ -35,33 +34,31 @@ module SmartKv::Meat
   end
 
   def init_optional
-    @optional ||= superclass == SmartKv ? Set.new : superclass.optional.dup
+    @optional ||= superclass == SmartKv ? ::Set.new : superclass.optional.dup
   end
 
   def keys
-    Array(@required) + Array(@optional)
+    init_required; init_optional
+    @required + @optional
   end
 
   def check(kv={})
-    prevent_direct_instantiation
+    prevent_direct_usage
 
     object_class = callable_class || kv.class
     kv = kv.dup
 
-    unless SmartKv::Check.production?
-      required_keys = Array(@required)
-      optional_keys = Array(@optional)
-
+    unless SmartKv::Helper.production?
       hash = kv.to_h
       missing_keys = required_keys - hash.keys
       unless missing_keys.empty?
         raise SmartKv::KeyError, "missing required key(s): #{missing_keys.map{|k| k.to_sym.inspect }.join(', ')} in #{self.class}"
       end
 
-      unrecognized_keys = hash.keys - required_keys - optional_keys
+      unrecognized_keys = hash.keys - keys.to_a
       unless unrecognized_keys.empty?
         key = unrecognized_keys.first
-        raise SmartKv::KeyError.new("unrecognized key: #{key.inspect} for #{self}.", key: key, receiver: (keys - hash.keys).map {|k| [k, nil] }.to_h)
+        raise SmartKv::KeyError.new("unrecognized key: #{key.inspect} in #{self}.", key: key, receiver: (keys - hash.keys).map {|k| [k, nil] }.to_h)
       end
     end
 
@@ -79,9 +76,9 @@ module SmartKv::Meat
 
 private
 
-  def prevent_direct_instantiation
+  def prevent_direct_usage
     if self == SmartKv
-      raise SmartKv::CheckError, "only subclass of SmartKv is meant to be used".freeze
+      raise SmartKv::DirectUsageError, "only subclass of SmartKv is meant to be used".freeze
     end
   end
 end

data/lib/smart_kv/errors.rb

@@ -1,5 +1,5 @@
 class SmartKv
-  CheckError = Class.new(StandardError)
+  DirectUsageError = Class.new(StandardError)
 
   class KeyError < ::KeyError
     attr_reader :key, :receiver

data/lib/smart_kv/{convert.rb → helper.rb}

@@ -1,4 +1,4 @@
-module SmartKv::Convert
+module SmartKv::Helper
   def to_callable_object(object_class, kv)
     if object_class == Struct
       Struct.new(*kv.to_h.keys).new(*kv.to_h.values)
@@ -10,4 +10,14 @@ module SmartKv::Convert
       object_class.new(kv.to_h)
     end
   end
+
+  module_function
+
+  def has_did_you_mean_key_error?
+    defined?(DidYouMean::KeyErrorChecker)
+  end
+
+  def production?
+    (ENV['RAILS_ENV'] || ENV['RACK_ENV']) == "production"
+  end
 end

data/lib/smart_kv/version.rb

@@ -1,3 +1,3 @@
 class SmartKv
-  VERSION = "0.2.7"
+  VERSION = "0.2.8.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smart_kv
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.2.8.1
 platform: ruby
 authors:
 - Adrian Setyadi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-18 00:00:00.000000000 Z
+date: 2020-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -127,11 +127,10 @@ files:
 - bin/console
 - bin/setup
 - lib/smart_kv.rb
-- lib/smart_kv/check.rb
-- lib/smart_kv/convert.rb
+- lib/smart_kv/core.rb
 - lib/smart_kv/did_you_mean.rb
 - lib/smart_kv/errors.rb
-- lib/smart_kv/meat.rb
+- lib/smart_kv/helper.rb
 - lib/smart_kv/version.rb
 - smart_kv.gemspec
 homepage: https://github.com/styd/smart_kv
@@ -153,8 +152,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Smart checks for your options or configurations.

data/lib/smart_kv/check.rb

@@ -1,11 +0,0 @@
-module SmartKv::Check
-  def has_did_you_mean_key_error?
-    defined?(DidYouMean::KeyErrorChecker)
-  end
-  module_function :has_did_you_mean_key_error?
-
-  def production?
-    (ENV['RAILS_ENV'] || ENV['RACK_ENV']) == "production"
-  end
-  module_function :production?
-end