contextuable 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f01ddee462e52b3629e919653e26fbc1dbd92464
-  data.tar.gz: 96f2d268eaade637bb222cd96e873c870a1d0223
+  metadata.gz: 8bd1b22c48cd964a9e88d7c24042a3a5237cf412
+  data.tar.gz: 29c4996901db2aaa4a4ca98618ddb2a912b11281
 SHA512:
-  metadata.gz: 66e68fc9f7ce8471999c194c89eb199b716eb0decd0e4ad1f1481e23079a28622a7266ff87692445160b11cd1deb2c831dfdac5e143552202d3d54e8eace98e5
-  data.tar.gz: 647bcd46a5b40ce789c849189e5ad5906813fe1fcc14cabf2d067ce841042552630206947405f6128beb7ed2e89ec209debd14d7f513d52971be8d942087804a
+  metadata.gz: 7c766b2fb0e126589259d917cead49aaffbc31f97df7edb4ce649215ad50dc0b55ab9c2736b004a9096d8e1765c763ba0941298a1a07c79ff238da02b48a9999
+  data.tar.gz: 71dabd1609822f5401b0a23f98bedeba540f737c834fb96d1779611609c575a0d69780c626c01d006611891ac2df5beb112a212d126bd378ac991d853d862bb9

data/README.md

@@ -21,17 +21,21 @@ Or install it yourself as:
 ## Usage
 
 __Extended OpenStruct:__
+
 ```ruby
   context = Contextuable.new(name: 'John', surname: 'Doe')
   context.name # => 'John'
-  context.name? # => true
+  context.name_provided? # => true
   context.surname # => 'Doe'
-  context.foo? # => false
+  context.foo_provided? # => false
+  context.foo_not_provided? # => true
   context.foo = :bar
-  context.foo? # => true
+  context.foo_provided? # => true
+  context.foo_not_provided? # => false
   context.foo # => :bar
   context.to_h # => {:name=>"John", :surname=>"Doe", :foo=>:bar}
 ```
+
 _more complex example_
 ```ruby
 class Input < Contextuable
@@ -54,10 +58,12 @@ i = Input.new(name: 'Hotel', city: 'Barcelona', address: 'Happy street', not_per
 i.types
 # => ["lodging"]
 i.long_name
-# => "Hotel,Happy street,Barcelona"
+# => "Hotel, Happy street, Barcelona"
+i.name
+# => "Hotel"
 i.hotel_name
 # => "Hotel"
-i.phone_number?
+i.phone_number_provided?
 # => false
 i.not_permitted
 # => nil
@@ -97,14 +103,18 @@ class Example2 < Contextuable
 end
 ex = Example2.new
 ex.foo
- => :bar
+# => :bar
 ex.bar
- => :foo
+# => :foo
+ex.foo = :hello
+ex.foo
+# => :hello
+
 ex2 = Example2.new(foo: 'something', bar: true)
 ex2.foo
- => 'something'
+# => 'something'
 ex2.bar
- => true
+# => true
 ```
 
 **ensure_presence**

data/contextuable.gemspec

@@ -8,7 +8,6 @@ Gem::Specification.new do |spec|
   spec.version       = Contextuable::VERSION
   spec.authors       = ["Artur Pañach"]
   spec.email         = ["arturictus@gmail.com"]
-
   spec.summary       = %q{Structs with steroids.}
   spec.description   = %q{Better way to improve your data structs.}
   spec.homepage      = "https://www.github.com/arturictus/contextuable"

data/lib/contextuable.rb

@@ -1,11 +1,10 @@
-# require 'forwardable'
 class Contextuable
-  # extend Forwardable
-  # delegate :[], to: :args
+  VERSION = "0.2.0"
 
-  VERSION = "0.1.0"
   class RequiredFieldNotPresent < ArgumentError; end
   class PresenceRequired < ArgumentError; end
+  class WrongArgument < ArgumentError; end
+
   class << self
     def required(*names)
       @_required = names.map(&:to_sym)
@@ -34,13 +33,11 @@ class Contextuable
   alias_method :to_hash, :args
 
   def initialize(hash = {})
-    fail ArgumentError unless hash.respond_to?(:fetch)
-    fail RequiredFieldNotPresent unless _required_args.map(&:to_sym).all? { |r| hash.keys.map(&:to_sym).include?(r) }
-    fail PresenceRequired if _presence_required.map(&:to_sym).any? { |r| hash[r].nil? }
+    check_input_errors(hash)
     hash = hash.select{|k, v| _permitted.include?(k.to_sym) } if _only_permitted?
     @args = _defaults.merge(hash)
     args.each do |k, v|
-      define_special_method(k, v)
+      define_contextuable_method(k, v)
     end
   end
 
@@ -60,10 +57,10 @@ class Contextuable
       key = name.to_s.gsub('=', '').to_sym
       set_attribute(key, value)
     else
-      # if name.to_s =~ /\anot_.?\z/
-        name.to_s.include?('?') ? false : nil
-      # else
-      # end
+      case name.to_s
+      when /\A\w+_not_provided\?\z/ then true
+      when /\A\w+_provided\?\z/ then false
+      end
     end
   end
 
@@ -71,13 +68,13 @@ class Contextuable
 
   def set_attribute(key, value)
     args[key] = value
-    define_special_method(key, value)
+    define_contextuable_method(key, value)
   end
 
-  def define_special_method(key, value)
+  def define_contextuable_method(key, value)
     define_singleton_method(key) { args.fetch(key) }
-    define_singleton_method("#{key}?") { true }
-    define_singleton_method("not_#{key}?") { false }
+    define_singleton_method("#{key}_provided?") { true }
+    define_singleton_method("#{key}_not_provided?") { false }
   end
 
   def find_in_equivalents(name)
@@ -121,4 +118,22 @@ class Contextuable
   def _required_args
     self.class.instance_variable_get(:@_required) || []
   end
+
+  def check_input_errors(hash)
+    unless hash.class <= Hash
+      fail WrongArgument, "[Contextuable ERROR]: `#{self.class}` expects to receive an `Hash` or and object having `Hash` as ancestor."
+    end
+
+    _required_args.map(&:to_sym).each do |r|
+      unless hash.keys.map(&:to_sym).include?(r)
+        fail RequiredFieldNotPresent, "[Contextuable ERROR]: `#{self.class}` expect to be initialized with `#{r}` as an attribute."
+      end
+    end
+
+    _presence_required.map(&:to_sym).each do |r|
+      if hash[r].nil?
+        fail PresenceRequired, "[Contextuable ERROR]: `#{self.class}` expects to receive an attribute named `#{r}` not beeing `nil`"
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: contextuable
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Artur Pañach
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-10 00:00:00.000000000 Z
+date: 2016-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -91,7 +91,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.2.3
 signing_key: 
 specification_version: 4
 summary: Structs with steroids.