smart_kv 0.2.3 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 18d8a80239ecbfcc6b948865773902b355f964763d1c48970abdd15cd0fd776b
-  data.tar.gz: 10b66b81f593f48ddbcfc3d9d2dcf53869c018b30ea2253e14b399973c12abb4
+  metadata.gz: 58e421790894c41c5608d79fcfb86c604b18e9f98f0a1591e76589358a5f31c9
+  data.tar.gz: 7916f3b61f1d53cd56ee4db704ea5424dd9b5b764dfefd2946eadd8eea3c2452
 SHA512:
-  metadata.gz: 5af3e66863206152ad3c01518e383ee02e377b8e26be7706986c7761831e7d0ed1a6fa08f8284cb6707fddb38e982b6cb120d3f020c47b489667f08755b51bc5
-  data.tar.gz: 8d9b376526c263a57d7bd8691ec847aeeca35a8b32e72098d763d965c8e3d707345b0c65495ccafc4d3d2b03e9048cb463629c0a4ec85b7a623c34d370bcffeb
+  metadata.gz: 41edbc48494258f1c55db913009e6cb722f2f70bbcba721afbc6d0a86b17f507b919dd58086aecbf2f6b8a78a00b474e12786c1bfca1aaa29cf62bcfcff1f844
+  data.tar.gz: 9a9b0280c67b828262442b27bebc28e70b77922facd2115e5dd19d5091c0959f705cb938cae5432d2888a1a4a3dbcb2ca37a0e653c0e902163c3266498e5abc2

data/.travis.yml

@@ -7,4 +7,4 @@ rvm:
   - 2.4.5
   - 2.5.3
   - 2.6.0
-before_install: gem install bundler -v 1.17.2
+before_install: gem install bundler -v 2.0.1

data/CODE_OF_CONDUCT.md

@@ -55,7 +55,7 @@ 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
+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.

data/lib/smart_kv.rb

@@ -1,61 +1,11 @@
-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"
-
-if has_did_you_mean_key_error?
-  require_relative "smart_kv/did_you_mean"
-end
+require_relative "smart_kv/check"
+require_relative "smart_kv/meat"
 
 class SmartKv
-  extend Register
-
-  attr_reader :object_class
-
-  def initialize(required_keys = [], optional_keys = [], object_class = nil, kv = {})
-    prevent_direct_instantiation
-
-    @object_class = object_class || kv.class
-    @kv = kv.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.to_sym.inspect }.join(', ')} in #{self.class}"
-    end
-
-    unrecognized_keys = hash.keys - required_keys - optional_keys
-    unless unrecognized_keys.empty?
-      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)
+  if Check.has_did_you_mean_key_error?
+    require_relative "smart_kv/did_you_mean"
   end
 
-  def method_missing(m, *args)
-    @object ||= if @object_class == Struct
-                  Struct.new(*@kv.to_h.keys).new(*@kv.to_h.values)
-                elsif @object_class < Struct
-                  @object_class.new(*@kv.to_h.values)
-                elsif @object_class <= Hash
-                  @kv
-                else
-                  @object_class.new(@kv.to_h)
-                end
-    @object.send(m, *args)
-  end
-
-protected
-
-  def prevent_direct_instantiation
-    if self.class == SmartKv
-      raise InitializationError, "only subclass of SmartConfig can be instantiated"
-    end
-  end
+  extend Meat
 end

data/lib/smart_kv/check.rb

@@ -0,0 +1,11 @@
+module SmartKv::Check
+  def has_did_you_mean_key_error?
+    !ENV['TRAVIS'] && 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

data/lib/smart_kv/convert.rb

@@ -0,0 +1,13 @@
+module SmartKv::Convert
+  def to_callable_object(object_class, kv)
+    if object_class == Struct
+      Struct.new(*kv.to_h.keys).new(*kv.to_h.values)
+    elsif object_class < Struct
+      object_class.new(*kv.to_h.values)
+    elsif object_class <= Hash
+      kv.to_h
+    else
+      object_class.new(kv.to_h)
+    end
+  end
+end

data/lib/smart_kv/did_you_mean.rb

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

data/lib/smart_kv/errors.rb

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

data/lib/smart_kv/meat.rb

@@ -0,0 +1,77 @@
+require_relative "errors"
+require_relative "convert"
+
+module SmartKv::Meat
+  # The meat of the gem
+
+  include SmartKv::Convert
+
+  def required(*args)
+    @required ||= superclass == SmartKv ? Set.new : superclass.required_keys.dup
+    @required += args
+    @optional -= @required if @optional
+    @required
+  end
+
+  def required_keys
+    @required.to_a
+  end
+
+  def optional(*args)
+    @optional ||= superclass == SmartKv ? Set.new : superclass.optional_keys.dup
+    @optional += args
+    @required -= @optional if @required
+    @optional
+  end
+
+  def optional_keys
+    @optional.to_a
+  end
+
+  def keys
+    Array(@required) + Array(@optional)
+  end
+
+  def check(kv={})
+    prevent_direct_instantiation
+
+    object_class = callable_class || kv.class
+    kv = kv.dup
+
+    unless SmartKv::Check.production?
+      required_keys = Array(@required)
+      optional_keys = Array(@optional)
+
+      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
+      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)
+      end
+    end
+
+    return to_callable_object(object_class, kv)
+  end
+  alias_method :new, :check
+
+  def callable_as(klass)
+    @callable_as = superclass == SmartKv ? klass : superclass.callable_class
+  end
+
+  def callable_class
+    @callable_as
+  end
+
+private
+
+  def prevent_direct_instantiation
+    if self == SmartKv
+      raise SmartKv::InitializationError, "only subclass of SmartConfig can be instantiated".freeze
+    end
+  end
+end

data/lib/smart_kv/version.rb

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

data/smart_kv.gemspec

@@ -23,10 +23,10 @@ Gem::Specification.new do |spec|
   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 "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 12.3"
   spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "coveralls"
+  spec.add_development_dependency "coveralls", "~> 0.8.22"
   spec.add_development_dependency "pry", "~> 0.12"
   spec.add_development_dependency "pry-byebug", "~> 3.6"
   spec.add_development_dependency "pry-doc"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smart_kv
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.6
 platform: ruby
 authors:
 - Adrian Setyadi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-24 00:00:00.000000000 Z
+date: 2019-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -56,16 +56,16 @@ dependencies:
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.8.22
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.8.22
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -128,9 +128,11 @@ files:
 - bin/console
 - bin/setup
 - lib/smart_kv.rb
+- lib/smart_kv/check.rb
+- lib/smart_kv/convert.rb
 - lib/smart_kv/did_you_mean.rb
 - lib/smart_kv/errors.rb
-- lib/smart_kv/register.rb
+- lib/smart_kv/meat.rb
 - lib/smart_kv/version.rb
 - smart_kv.gemspec
 homepage: https://github.com/styd/smart_kv

data/lib/smart_kv/register.rb

@@ -1,35 +0,0 @@
-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
-    @required.to_a
-  end
-
-  def optional(*args)
-    @optional ||= superclass == SmartKv ? Set.new : superclass.optional_keys.dup
-    @optional += args
-    @required -= @optional if @required
-    @optional
-  end
-
-  def optional_keys
-    @optional.to_a
-  end
-
-  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