smart_kv 0.2.6 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 58e421790894c41c5608d79fcfb86c604b18e9f98f0a1591e76589358a5f31c9
-  data.tar.gz: 7916f3b61f1d53cd56ee4db704ea5424dd9b5b764dfefd2946eadd8eea3c2452
+  metadata.gz: a40cd8eb22b67d869043b25fd77f73700f21c40dd0302cfc6d59d436fd89027f
+  data.tar.gz: faca0c5c75a0437de06f2e8a7eddd64097578b49187a46f0aecc4abfcf350c26
 SHA512:
-  metadata.gz: 41edbc48494258f1c55db913009e6cb722f2f70bbcba721afbc6d0a86b17f507b919dd58086aecbf2f6b8a78a00b474e12786c1bfca1aaa29cf62bcfcff1f844
-  data.tar.gz: 9a9b0280c67b828262442b27bebc28e70b77922facd2115e5dd19d5091c0959f705cb938cae5432d2888a1a4a3dbcb2ca37a0e653c0e902163c3266498e5abc2
+  metadata.gz: d4c7ee93525e01eb972ded20303bdb252897c009fbb6e0901d16e26481a7d859e8884b6f6cb44b51ea5569bb4ef8709cbfff05d1aaefbf2f188a1a898fd07bb2
+  data.tar.gz: 0fb4bce5f669b7afb31b5430e6aeb69b768b1e5acce875a9249976162c11a716490893aea011a669259344684a8730f06695474724877bc702681c52d0db545b

data/README.md

@@ -4,10 +4,7 @@
 [![Coverage Status](https://coveralls.io/repos/github/styd/smart_kv/badge.svg?branch=master)](https://coveralls.io/github/styd/smart_kv?branch=master)
 [![Gem Version](https://badge.fury.io/rb/smart_kv.svg)](https://rubygems.org/gems/smart_kv)
 
-Best practice of writing options or configurations by strictly allowing and requiring keys.
-
-It doesn't have to be options or configurations.
-You can use it for strict request body or other use cases too.
+Write options or configurations without worry of typos and the need to remember all the keys.
 
 ## Background
 
@@ -19,24 +16,12 @@ d = DateTime.now
 e = d.change(hour: 1, minute: 5)
 ```
 
-and then move on with your life.. until you realize that the code doesn't behave as you expected it to behave.  
-But why? Everything looks fine, right? Yes, it does look fine.. but it's not fine.  
-
-So, what's the problem?  
-The problem was the option key `:minute` was not recognized.  
-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 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.
-
+You think everything works fine, but it's not.  
+There is no key `:minute` in options used by `#change`.  
 If only the source of the `DateTime#change` method starts like this:
 
 ```ruby
-# this class can be defined on its own file
+# this class can be defined on its own file, just remember to require it
 class ChangeOptions < SmartKv
   optional :nsec, :usec, :year, :month, :day, :hour, :min, :sec, :offset, :start
 end
@@ -44,7 +29,7 @@ end
 class DateTime
 ...
   def change(options)
-    options = ChangeOptions.new(options)
+    options = ChangeOptions.check(options)
     ...
   end
 end
@@ -53,14 +38,14 @@ end
 So, when you do this `d.change(hour: 1, minute: 5)`, it will yell:
 
 ```
-NotImplementedError: unrecognized key(s): `:minute' in ChangeOptions
+KeyError: unrecognized key: :minute in ChangeOptions
 ```
 
 Well, this is better. But, how do you know all the right options?  
-Type: `ChangeOptions.optional_keys` and `ChangeOptions.required_keys`.
+Type: `ChangeOptions.keys`
 
 
-## More Usage Example
+## More Usage Examples
 
 ```ruby
 class Config < SmartKv
@@ -68,7 +53,7 @@ class Config < SmartKv
   optional :an_option
 end
 
-Config.new({some_key: "val"})
+Config.check({some_key: "val"})
 ```
 
 This will complain that you're not using the `:second key`.
@@ -83,7 +68,7 @@ class ChildConfig < Config
   required :first_key
 end
 
-ChildConfig.new({first_key: "val", second_key: "val 2"})
+ChildConfig.check({first_key: "val", second_key: "val 2"})
 ```
 
 This will also complain that you're not using the `:some_key`.
@@ -94,10 +79,10 @@ This will also complain that you're not using the `:some_key`.
 Whatever given as input is callable directly.
 
 ```ruby
-c = Config.new({some_key: "val", second_key: "val 2"})
+c = Config.check({some_key: "val", second_key: "val 2"})
 c[:some_key]
 
-c2 = Config.new(OpenStruct.new({some_key: "val", second_key: "val 2"}))
+c2 = Config.check(OpenStruct.new({some_key: "val", second_key: "val 2"}))
 c2.second_key
 ```
 
@@ -112,7 +97,7 @@ class Convertable < SmartKv
   callable_as OpenStruct
 end
 
-c = Convertable.new({abcd: 123})
+c = Convertable.check({abcd: 123})
 c.abcd #=> 123
 ```
 
@@ -127,7 +112,7 @@ class PostBody < SmartKv
 end
 .
 .
-request.set_form_data(PostBody.new({app_key: "abc", secret_key: "def"}))
+request.set_form_data(PostBody.check({app_key: "abc", secret_key: "def"}))
 ```
 
 
@@ -139,20 +124,6 @@ Add this line to your application's Gemfile:
 gem 'smart_kv'
 ```
 
-And then execute:
-
-    $ bundle
-
-
-## Coming Soon
-
-- [X] Convertable from hash (as input) to OpenStruct (the resulting object) or another object and vice versa
-- [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
-
-
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/styd/smart_kv. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
@@ -161,8 +132,3 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/styd/s
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-
-
-## Code of Conduct
-
-Everyone interacting in the SmartKv project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/styd/smart_kv/blob/master/CODE_OF_CONDUCT.md).

data/lib/smart_kv/check.rb

@@ -1,6 +1,6 @@
 module SmartKv::Check
   def has_did_you_mean_key_error?
-    !ENV['TRAVIS'] && defined?(DidYouMean::KeyErrorChecker)
+    defined?(DidYouMean::KeyErrorChecker)
   end
   module_function :has_did_you_mean_key_error?
 

data/lib/smart_kv/errors.rb

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

data/lib/smart_kv/meat.rb

@@ -7,27 +7,37 @@ module SmartKv::Meat
   include SmartKv::Convert
 
   def required(*args)
-    @required ||= superclass == SmartKv ? Set.new : superclass.required_keys.dup
+    init_required
     @required += args
     @optional -= @required if @optional
     @required
   end
 
   def required_keys
+    init_required
     @required.to_a
   end
 
+  def init_required
+    @required ||= superclass == SmartKv ? Set.new : superclass.required.dup
+  end
+
   def optional(*args)
-    @optional ||= superclass == SmartKv ? Set.new : superclass.optional_keys.dup
+    init_optional
     @optional += args
     @required -= @optional if @required
     @optional
   end
 
   def optional_keys
+    init_optional
     @optional.to_a
   end
 
+  def init_optional
+    @optional ||= superclass == SmartKv ? Set.new : superclass.optional.dup
+  end
+
   def keys
     Array(@required) + Array(@optional)
   end
@@ -51,7 +61,7 @@ module SmartKv::Meat
       unrecognized_keys = hash.keys - required_keys - optional_keys
       unless unrecognized_keys.empty?
         key = unrecognized_keys.first
-        raise SmartKv::KeyError.new("key not found: #{key.inspect}.", key: key, receiver: (keys - hash.keys).map {|k| [k, nil] }.to_h)
+        raise SmartKv::KeyError.new("unrecognized key: #{key.inspect} for #{self}.", key: key, receiver: (keys - hash.keys).map {|k| [k, nil] }.to_h)
       end
     end
 
@@ -71,7 +81,7 @@ private
 
   def prevent_direct_instantiation
     if self == SmartKv
-      raise SmartKv::InitializationError, "only subclass of SmartConfig can be instantiated".freeze
+      raise SmartKv::CheckError, "only subclass of SmartKv is meant to be used".freeze
     end
   end
 end

data/lib/smart_kv/version.rb

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

data/smart_kv.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Adrian Setyadi"]
   spec.email         = ["a.styd@yahoo.com"]
 
-  spec.summary       = %q{Smart checks for your key value objects.}
-  spec.description   = %q{Best practice of writing options or configurations by strictly allowing and requiring keys.}
+  spec.summary       = %q{Smart checks for your options or configurations.}
+  spec.description   = %q{Write options or configurations without worry of typos and the need to remember all the keys.}
   spec.homepage      = "https://github.com/styd/smart_kv"
   spec.license       = "MIT"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smart_kv
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.2.7
 platform: ruby
 authors:
 - Adrian Setyadi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-08 00:00:00.000000000 Z
+date: 2019-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -108,8 +108,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Best practice of writing options or configurations by strictly allowing
-  and requiring keys.
+description: Write options or configurations without worry of typos and the need to
+  remember all the keys.
 email:
 - a.styd@yahoo.com
 executables: []
@@ -120,7 +120,6 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
-- CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -158,5 +157,5 @@ rubyforge_project:
 rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
-summary: Smart checks for your key value objects.
+summary: Smart checks for your options or configurations.
 test_files: []

data/CODE_OF_CONDUCT.md

@@ -1,74 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, gender identity and expression, level of experience,
-nationality, personal appearance, race, religion, or sexual identity and
-orientation.
-
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment
-include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery and unwelcome sexual attention or
-advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
-  address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
-
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
-
-## Scope
-
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at a.styd@yahoo.com. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at [http://contributor-covenant.org/version/1/4][version]
-
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/4/