smart_kv 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de163a1fc2ca9dd60c4a4fa174cc70e1151aa37f1acdf22ae16e7edfbe975533
-  data.tar.gz: 7b537f4c5d60b2824b8a861d36843b228403d5539e4027fc8edbc1048ea25207
+  metadata.gz: 420ce0e7d38260c55c3727e37875a5d0874c500ec3c47c402b309a3d026c77ab
+  data.tar.gz: 58c5c54dad2de77d66d64253672a842be8fab34fa744c3d287dfbac34d68acf4
 SHA512:
-  metadata.gz: af05f4d2f86e30f8b84544c762171e8467a1a24e26b690084ee19469b1925180410f26f77557a99602ba78965debe385541cb1d716e1f86e1d34213d5af4ffa8
-  data.tar.gz: 6db718ef3cc738d354d82246ba0286dd081a8e868e7f46ef5b71943498194188b1563a96a9d5cce2810c99918cad30fe3fd110724d3ec044c091c35e7796185a
+  metadata.gz: 6c6a325bdee6c9ce5e70e0384afc79f5d754798077667294f0d672d1ea947438fa1860f1e4fe6f1b5fcb68b7a374a2d135744cc78d4eed1b730b25773ba6a17f
+  data.tar.gz: 70c77c085f843d4f8b8d2e533e7bbe180c4cb9da7f38cc5b4066d891775a22e84e88524cf390ba22c9536da23c1da6148a0c76058996106f70bcfcc3c6aa1ded

data/.coveralls.yml

@@ -0,0 +1 @@
+repo_token: 2GrR1SPa8lXAm5kYn2fqp4N7pJGbvW8rO

data/Gemfile

@@ -9,6 +9,7 @@ end
 
 group :test do
   gem "rspec", "~> 3.0"
+  gem 'coveralls', require: false
 end
 
 group :development do

data/Gemfile.lock

@@ -3,7 +3,15 @@ GEM
   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)
@@ -25,12 +33,22 @@ GEM
       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)

data/README.md

@@ -1,25 +1,64 @@
 # SmartKv
 
 [![Build Status](https://travis-ci.org/styd/smart_kv.svg?branch=master)](https://travis-ci.org/styd/smart_kv)
+[![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 configurations by strictly allowing and requiring keys.
+Best practice of writing options or configurations by strictly allowing and requiring keys.
 
-It doesn't have to be a configuration.
+It doesn't have to be options or configurations.
 You can use it for strict request body or other use cases too.
 
-## Installation
+## Background
 
-Add this line to your application's Gemfile:
+Have you ever used ruby options like this:
 
 ```ruby
-gem 'smart_kv'
+# this example is for rails
+d = DateTime.now
+e = d.change(hour: 1, minute: 5)
 ```
 
-And then execute:
+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.  
 
-    $ bundle
+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 not raise error -
+and most developers won't bother checking each options' key made by the users of the library or method.  
 
-## Usage
+If only the source of the `DateTime#change` method starts like this:
+
+```ruby
+# this class can be defined on its own file
+class ChangeOptions < SmartKv
+  optional :nsec, :usec, :year, :month, :day, :hour, :min, :sec, :offset, :start
+end
+
+class DateTime
+...
+  def change(options)
+    options = ChangeOptions.new(options)
+    ...
+  end
+end
+```
+
+So, when you do this `d.change(hour: 1, minute: 5)`, it will yell:
+
+```
+NotImplementedError: unrecognized key(s): `:minute' in ChangeOptions
+```
+
+Well, this is better. But, how do you know all the right options?  
+Type: `ChangeOptions.optional_keys` and `ChangeOptions.required_keys`.
+
+
+## More Usage Example
 
 ```ruby
 class Config < SmartKv
@@ -31,7 +70,9 @@ Config.new({some_key: "val"})
 ```
 
 This will complain that you're not using the `:second key`.
-Guess what the `optional` do!
+If you add another key that is not recognized, it will complain too.
+If there is a key that you don't always use but want it to be recognized, mark it as `optional`.
+
 
 ### Inheritable
 
@@ -45,6 +86,7 @@ ChildConfig.new({first_key: "val", second_key: "val 2"})
 
 This will also complain that you're not using the `:some_key`.
 
+
 ### Directly callable
 
 Whatever given as input is callable directly.
@@ -57,6 +99,7 @@ c2 = Config.new(OpenStruct.new({some_key: "val", second_key: "val 2"}))
 c2.second_key
 ```
 
+
 ### Override callable object
 
 You can change the callable object to any class that accepts hash as input of its new class method.
@@ -71,9 +114,10 @@ c = Convertable.new({abcd: 123})
 c.abcd #=> 123
 ```
 
-### Not using it for config
 
-You can choose not to use it for config. Maybe for strict request body keys?
+### Not using it for options or configs?
+
+You can choose not to use it for options or configs. Maybe for strict request body keys?
 
 ```ruby
 class PostBody < SmartKv
@@ -84,22 +128,39 @@ end
 request.set_form_data(PostBody.new({app_key: "abc", secret_key: "def"}))
 ```
 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'smart_kv'
+```
+
+And then execute:
+
+    $ bundle
+
+
 ## Coming Soon
 
-- [ ] Make it serializable
 - [X] Convertable from hash (as input) to OpenStruct (the resulting object) or another object and vice versa
-- [ ] Accept config file (e.g. `json`, `yaml`, etc.) or file path as input
+- [ ] Suggests corrections for unrecognized keys using DidYouMean (and maybe change the spell checking threshold?)
 - [ ] 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.
 
+
 ## 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.rb

@@ -1,12 +1,10 @@
 require "smart_kv/version"
 require "smart_kv/register"
-require "smart_kv/macro"
 
 SmartKvInitializationError = Class.new(StandardError)
 
 class SmartKv
   extend Register
-  extend Macro
 
   attr_reader :object_class
 
@@ -16,10 +14,6 @@ class SmartKv
     @object_class = object_class || kv.class
     @kv = kv.dup
 
-    if @object_class.respond_to?(:members) && @object_class.members != @kv.to_h.keys
-      raise ArgumentError, "#{ @object_class } struct size differs"
-    end
-
     hash = kv.to_h.dup
     missing_keys = required_keys - hash.keys
     unless missing_keys.empty?

data/lib/smart_kv/register.rb

@@ -2,6 +2,8 @@ module SmartKv::Register
   def required(*args)
     @required ||= superclass == SmartKv ? Set.new : superclass.required_keys.dup
     @required += args
+    @optional -= @required if @optional
+    @required
   end
 
   def required_keys
@@ -11,7 +13,7 @@ module SmartKv::Register
   def optional(*args)
     @optional ||= superclass == SmartKv ? Set.new : superclass.optional_keys.dup
     @optional += args
-    @required -= @optional
+    @required -= @optional if @required
     @optional
   end
 
@@ -22,4 +24,12 @@ module SmartKv::Register
   def new(*args)
     super(@required.to_a, @optional.to_a, @callable_as, *args)
   end
+
+  def callable_as(klass)
+    @callable_as = superclass == SmartKv ? klass : superclass.callable_class
+  end
+
+  def callable_class
+    @callable_as
+  end
 end

data/lib/smart_kv/version.rb

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

data/smart_kv.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["a.styd@yahoo.com"]
 
   spec.summary       = %q{Smart checks for your key value objects.}
-  spec.description   = %q{Best practice of writing configurations by strictly allowing and requiring keys.}
+  spec.description   = %q{Best practice of writing options or configurations by strictly allowing and requiring keys.}
   spec.homepage      = "https://github.com/styd/smart_kv"
   spec.license       = "MIT"
 

metadata

@@ -1,23 +1,24 @@
 --- !ruby/object:Gem::Specification
 name: smart_kv
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Adrian Setyadi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-12-25 00:00:00.000000000 Z
+date: 2019-01-06 00:00:00.000000000 Z
 dependencies: []
-description: Best practice of writing configurations by strictly allowing and requiring
-  keys.
+description: Best practice of writing options or configurations by strictly allowing
+  and requiring keys.
 email:
 - a.styd@yahoo.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".coveralls.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -30,7 +31,6 @@ files:
 - bin/console
 - bin/setup
 - lib/smart_kv.rb
-- lib/smart_kv/macro.rb
 - lib/smart_kv/register.rb
 - lib/smart_kv/version.rb
 - smart_kv.gemspec

data/lib/smart_kv/macro.rb

@@ -1,9 +0,0 @@
-module SmartKv::Macro
-  def callable_as(klass)
-    @callable_as = superclass == SmartKv ? klass : superclass.callable_class
-  end
-
-  def callable_class
-    @callable_as
-  end
-end