smart_kv 0.1.4 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 420ce0e7d38260c55c3727e37875a5d0874c500ec3c47c402b309a3d026c77ab
-  data.tar.gz: 58c5c54dad2de77d66d64253672a842be8fab34fa744c3d287dfbac34d68acf4
+  metadata.gz: 18d8a80239ecbfcc6b948865773902b355f964763d1c48970abdd15cd0fd776b
+  data.tar.gz: 10b66b81f593f48ddbcfc3d9d2dcf53869c018b30ea2253e14b399973c12abb4
 SHA512:
-  metadata.gz: 6c6a325bdee6c9ce5e70e0384afc79f5d754798077667294f0d672d1ea947438fa1860f1e4fe6f1b5fcb68b7a374a2d135744cc78d4eed1b730b25773ba6a17f
-  data.tar.gz: 70c77c085f843d4f8b8d2e533e7bbe180c4cb9da7f38cc5b4066d891775a22e84e88524cf390ba22c9536da23c1da6148a0c76058996106f70bcfcc3c6aa1ded
+  metadata.gz: 5af3e66863206152ad3c01518e383ee02e377b8e26be7706986c7761831e7d0ed1a6fa08f8284cb6707fddb38e982b6cb120d3f020c47b489667f08755b51bc5
+  data.tar.gz: 8d9b376526c263a57d7bd8691ec847aeeca35a8b32e72098d763d965c8e3d707345b0c65495ccafc4d3d2b03e9048cb463629c0a4ec85b7a623c34d370bcffeb

data/.gitignore

@@ -6,6 +6,7 @@
 /pkg/
 /spec/reports/
 /tmp/
+Gemfile.lock
 
 # rspec failure tracking
 .rspec_status

data/.travis.yml

@@ -6,4 +6,5 @@ rvm:
   - 2.3.8
   - 2.4.5
   - 2.5.3
+  - 2.6.0
 before_install: gem install bundler -v 1.17.2

data/Gemfile

@@ -2,17 +2,4 @@ source "https://rubygems.org"
 
 git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 
-group :development, :test do
-  gem "pry", "~> 0.12"
-  gem "pry-byebug", "~> 3.6"
-end
-
-group :test do
-  gem "rspec", "~> 3.0"
-  gem 'coveralls', require: false
-end
-
-group :development do
-  gem "bundler", "~> 1.17"
-  gem "rake", "~> 10.0"
-end
+gemspec

data/README.md

@@ -28,8 +28,10 @@ Eh? :confused:
 Why didn't it tell me if it was not recognized?  
 
 I wish that too.  
-But `Hash` has a default value of `nil` if key is not found (same thing applies to `OpenStruct`) - so, it will not raise error -
-and most developers won't bother checking each options' key made by the users of the library or method.  
+But `Hash` has a default value of `nil` if key is not found (same thing applies to `OpenStruct`). 
+So, it will fail gracefully even if an option is actually required, unless the developer uses `#fetch` instead of `#[]`.
+Even if the developer uses `#fetch` for required keys, it doesn't actually check if there are foreign keys input.
+Also, most developers won't bother checking each options' key made by the users of the library or method.
 
 If only the source of the `DateTime#change` method starts like this:
 
@@ -145,7 +147,7 @@ And then execute:
 ## Coming Soon
 
 - [X] Convertable from hash (as input) to OpenStruct (the resulting object) or another object and vice versa
-- [ ] Suggests corrections for unrecognized keys using DidYouMean (and maybe change the spell checking threshold?)
+- [X] Suggests corrections for unrecognized keys using DidYouMean
 - [ ] Support nested/deep key value object as input
 - [ ] Make some nested keys from the same parent key required and some others optional
 - [ ] Accept config file (e.g. `json`, `yaml`, etc.) or file path as input

data/lib/smart_kv.rb

@@ -1,7 +1,14 @@
-require "smart_kv/version"
-require "smart_kv/register"
+def has_did_you_mean_key_error?
+  !ENV['TRAVIS'] && Gem::Version.new(RUBY_VERSION) > Gem::Version.new("2.5.0") && defined?(DidYouMean)
+end
+
+require_relative "smart_kv/version"
+require_relative "smart_kv/register"
+require_relative "smart_kv/errors"
 
-SmartKvInitializationError = Class.new(StandardError)
+if has_did_you_mean_key_error?
+  require_relative "smart_kv/did_you_mean"
+end
 
 class SmartKv
   extend Register
@@ -14,18 +21,23 @@ class SmartKv
     @object_class = object_class || kv.class
     @kv = kv.dup
 
-    hash = kv.to_h.dup
+    hash = kv.to_h
     missing_keys = required_keys - hash.keys
     unless missing_keys.empty?
-      raise KeyError, "missing required key(s): #{missing_keys.map{|k| "`:#{k}'" }.join(', ')} in #{self.class}"
+      raise 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
     unless unrecognized_keys.empty?
-      raise NotImplementedError, "unrecognized key(s): #{unrecognized_keys.map{|k| "`:#{k}'" }.join(', ')} in #{self.class}"
+      key = unrecognized_keys.first
+      raise KeyError.new("key not found: #{key.inspect}.", key: key, receiver: (keys - hash.keys).map {|k| [k, nil] }.to_h)
     end
   end
 
+  def keys
+    Array(self.class.required) + Array(self.class.optional)
+  end
+
   def method_missing(m, *args)
     @object ||= if @object_class == Struct
                   Struct.new(*@kv.to_h.keys).new(*@kv.to_h.values)
@@ -43,7 +55,7 @@ protected
 
   def prevent_direct_instantiation
     if self.class == SmartKv
-      raise SmartKvInitializationError, "only subclass of SmartConfig can be instantiated"
+      raise InitializationError, "only subclass of SmartConfig can be instantiated"
     end
   end
 end

data/lib/smart_kv/did_you_mean.rb

@@ -0,0 +1,7 @@
+module DidYouMean
+  SPELL_CHECKERS.merge!({
+    'SmartKv::KeyError' => KeyErrorChecker
+  })
+
+  ::SmartKv::KeyError.prepend DidYouMean::Correctable
+end

data/lib/smart_kv/errors.rb

@@ -0,0 +1,13 @@
+class SmartKv
+  InitializationError = Class.new(StandardError)
+
+  class KeyError < ::StandardError
+    attr_reader :key, :receiver
+
+    def initialize(message, key: nil, receiver: {})
+      @key = key
+      @receiver = receiver
+      super(message)
+    end
+  end
+end

data/lib/smart_kv/version.rb

@@ -1,3 +1,3 @@
 class SmartKv
-  VERSION = "0.1.4"
+  VERSION = "0.2.3"
 end

data/smart_kv.gemspec

@@ -22,4 +22,12 @@ Gem::Specification.new do |spec|
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "coveralls"
+  spec.add_development_dependency "pry", "~> 0.12"
+  spec.add_development_dependency "pry-byebug", "~> 3.6"
+  spec.add_development_dependency "pry-doc"
 end

metadata

@@ -1,15 +1,113 @@
 --- !ruby/object:Gem::Specification
 name: smart_kv
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.3
 platform: ruby
 authors:
 - Adrian Setyadi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-06 00:00:00.000000000 Z
-dependencies: []
+date: 2019-02-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: pry-doc
+  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: Best practice of writing options or configurations by strictly allowing
   and requiring keys.
 email:
@@ -24,13 +122,14 @@ files:
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
 - lib/smart_kv.rb
+- lib/smart_kv/did_you_mean.rb
+- lib/smart_kv/errors.rb
 - lib/smart_kv/register.rb
 - lib/smart_kv/version.rb
 - smart_kv.gemspec

data/Gemfile.lock

@@ -1,58 +0,0 @@
-GEM
-  remote: https://rubygems.org/
-  specs:
-    byebug (10.0.2)
-    coderay (1.1.2)
-    coveralls (0.8.22)
-      json (>= 1.8, < 3)
-      simplecov (~> 0.16.1)
-      term-ansicolor (~> 1.3)
-      thor (~> 0.19.4)
-      tins (~> 1.6)
-    diff-lcs (1.3)
-    docile (1.3.1)
-    json (2.1.0)
-    method_source (0.9.2)
-    pry (0.12.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    pry-byebug (3.6.0)
-      byebug (~> 10.0)
-      pry (~> 0.10)
-    rake (10.5.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
-    simplecov (0.16.1)
-      docile (~> 1.1)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.2)
-    term-ansicolor (1.7.0)
-      tins (~> 1.0)
-    thor (0.19.4)
-    tins (1.20.2)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.17)
-  coveralls
-  pry (~> 0.12)
-  pry-byebug (~> 3.6)
-  rake (~> 10.0)
-  rspec (~> 3.0)
-
-BUNDLED WITH
-   1.17.2