smart_kv 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4208fdf9d213d96387a105205361aef760652dce3da67f1e282d5a9eb6132d30
+  data.tar.gz: 0c84eb3e3bad64d9e934b3cbc996092f24960be346770c5da690745b1555ab06
+SHA512:
+  metadata.gz: 8621c06a03951e97723466f53e2c293ccb096c3bf504ad58a0cb16e6154c38220e9c87ee97a2d2912ba7299da517aa5192e21097cd5316d3b599bb6474e999a4
+  data.tar.gz: 6befe669b9f541dd998a64a8db3b0c3a9f501fff11268417fcbea09f8fa73813496af1cf11bb0aa3f646e8a47b52f783487a00dac18839ae4c0d052a1521206f

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,12 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.8
+  - 2.4.5
+  - 2.5.3
+  - jruby-9.2.5.0
+  - rbx-3.107
+  - truffleruby-1.0.0-rc10
+before_install: gem install bundler -v 1.17.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# 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 adrian@setyadi.pro. 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/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in smart_kv.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,41 @@
+PATH
+  remote: .
+  specs:
+    smart_kv (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    method_source (0.9.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    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)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  pry (~> 0.12)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  smart_kv!
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Adrian Setyadi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,89 @@
+# SmartKv
+
+Best practice of writing configurations by strictly allowing and requiring keys.
+
+It doesn't have to be a configuration.
+You can use it for strict request body or other use cases too.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'smart_kv'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+```ruby
+class Config < SmartKv
+  required :some_key, :second_key
+  optional :an_option
+end
+
+Config.new({some_key: "val"})
+```
+
+This will complain that you're not using the `:second key`.
+Guess what the `optional` do!
+
+### Inheritable
+
+```ruby
+class ChildConfig < Config
+  required :first_key
+end
+
+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.
+
+```ruby
+c = Config.new({some_key: "val", second_key: "val 2"})
+c[:some_key]
+
+c2 = Config.new(OpenStruct.new({some_key: "val", second_key: "val 2"}))
+c2.second_key
+```
+
+### Not using it for config
+
+You can choose not to use it for config. Maybe for strict request body keys?
+
+```ruby
+class PostBody < SmartKv
+  required :app_key, :secret_key
+end
+.
+.
+request.set_form_data(PostBody.new({app_key: "abc", secret_key: "def"}))
+```
+
+## Coming Soon
+
+- [ ] Make it serializable
+- [ ] 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
+- [ ] Support nested/deep key value object as input
+- [ ] Make some nested keys from the same parent key required and some others optional
+
+## 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/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "smart_kv"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/smart_kv/register.rb

@@ -0,0 +1,25 @@
+module SmartKv::Register
+  def required(*args)
+    @required ||= self.superclass == SmartKv ? Set.new : superclass.required_keys.dup
+    @required += args
+  end
+
+  def required_keys
+    @required.to_a
+  end
+
+  def optional(*args)
+    @optional ||= self.superclass == SmartKv ? Set.new : superclass.optional_keys.dup
+    @optional += args
+    @required -= @optional
+    @optional
+  end
+
+  def optional_keys
+    @optional.to_a
+  end
+
+  def new(*args)
+    super(@required.to_a, @optional.to_a, *args)
+  end
+end

data/lib/smart_kv/version.rb

@@ -0,0 +1,3 @@
+class SmartKv
+  VERSION = "0.1.0"
+end

data/lib/smart_kv.rb

@@ -0,0 +1,37 @@
+require "smart_kv/version"
+require "smart_kv/register"
+
+SmartKvInitializationError = Class.new(StandardError)
+
+class SmartKv
+  extend Register
+
+  def initialize(required_keys = [], optional_keys = [], kv = {})
+    prevent_direct_instantiation
+
+    @kv = kv
+    hash = kv.to_h.dup
+
+    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}"
+    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}"
+    end
+  end
+
+  def method_missing(m, *args)
+    @kv.send(m, *args)
+  end 
+
+protected
+
+  def prevent_direct_instantiation
+    if self.class == SmartKv
+      raise SmartKvInitializationError, "only subclass of SmartConfig can be instantiated"
+    end
+  end
+end

data/smart_kv.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "smart_kv/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "smart_kv"
+  spec.version       = SmartKv::VERSION
+  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 configurations by strictly allowing and requiring keys.}
+  spec.homepage      = "https://github.com/styd/smart_kv"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  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 "pry", "~> 0.12"
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: smart_kv
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Adrian Setyadi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-12-16 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: 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'
+description: Best practice of writing configurations by strictly allowing and requiring
+  keys.
+email:
+- a.styd@yahoo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".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/register.rb
+- lib/smart_kv/version.rb
+- smart_kv.gemspec
+homepage: https://github.com/styd/smart_kv
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Smart checks for your key value objects.
+test_files: []