watir_model 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9085dc14b69f2a8e1ed12aecd5241f513e990524
-  data.tar.gz: 2be96f1b547f5f1b7b572f87bd02f808c704fad4
+  metadata.gz: fb66fe24b50991cf49d310d6a97f089e30913591
+  data.tar.gz: 7e3688b4c12b17d386371604ab359e63cdb66434
 SHA512:
-  metadata.gz: a15324a7547c57422ffeec87c1c3a957ba6acfb9341b198145f59aa6857e488d42b4d104c3d38cbad75c46fb6faef945a8d15c0a5028e579e16cd25f0a516520
-  data.tar.gz: ed15f70dc9e37ee0fac354d173b11b65caa73b4920105a3ed8b1685b3a9922b1fbf391f545bac116f13341602b79c0261f5f589b202d7f823eb7d8039bb86cc0
+  metadata.gz: e1c922f20e1d39fb88d9f8fc92cd08736937ebc63375a2f7c051cbf8751102dc5b17a19fb392cd8bba4076fdb5532c41e3805d416941690fffc5db0301cd1e5d
+  data.tar.gz: 2101fd335a12e59c92a8fb83d8d39ac9e22313ad1afd96453363a024e46926f814ccbb86567ecdefb3e5fb5a13ed0628d03136dc39eae2fcd8056b203249ea43

data/CHANGES.md

@@ -1,3 +1,10 @@
+### 0.4.0 (2017-12-24)
+
+* support for `:data_type` parameter to allow conversion and enforcement of key types
+* support for data defaults pulled from yaml files
+* support for referencing yaml defaults during initialization
+* support for key aliases to support comparing same values from different sources
+
 ### 0.3.1 (2017-05-19)
 
 * initialize and convert Model using Hash with keys as Strings

data/config/alternate/address.yml

@@ -0,0 +1,4 @@
+:alaska:
+    :state: AK
+    :city: Anchorage
+    :zip: '99501'

data/config/data/address.yml

@@ -0,0 +1,4 @@
+:alaska:
+    :state: AK
+    :city: Anchorage
+    :zip: '99501'

data/lib/watir_model.rb

@@ -1,30 +1,81 @@
 require 'active_support/hash_with_indifferent_access'
+require 'json'
+require 'date'
+require 'time'
+require 'yml_reader'
 
 class WatirModel
   class << self
+    include YmlReader
 
-    attr_writer :keys, :defaults
+    attr_writer :keys, :aliases, :data_types, :defaults
 
     def keys
       @keys ||= []
     end
 
+    def aliases
+      @aliases ||= {}
+    end
+
+    def data_types
+      @data_types ||= {}
+    end
+
     def defaults
       @defaults ||= {}
     end
 
     def inherited(subclass)
       subclass.keys = keys.dup
+      subclass.aliases = aliases.dup
       subclass.defaults = defaults.dup
+      subclass.data_types = data_types.dup
     end
 
-    # define a key and an optional block that provides a default value for the key
-    def key(symbol, &block)
+    def key(symbol, data_type: nil, aliases: [], &block)
       keys << symbol unless @keys.include? symbol
+      aliases.each { |alias_key| self.aliases[alias_key] = symbol }
       attr_accessor symbol
+      data_types[symbol] = data_type if data_type
       defaults[symbol] = block if block
     end
 
+    def convert_type(key, value)
+      data_type = data_types[key]
+      return value if data_type.nil?
+      return value if data_type.is_a?(Class) && value.is_a?(data_type)
+      value = case
+              when data_type == String
+                value.to_s
+              when data_type == Time
+                Time.parse value
+              when data_type == DateTime
+                DateTime.parse value
+              when data_type == Integer
+                value.to_i
+              when data_type == Float
+                value.to_f
+              when data_type == :boolean
+                return value if value.is_a?(TrueClass) || value.is_a?(FalseClass)
+                value = eval(value)
+                return value if value.is_a?(TrueClass) || value.is_a?(FalseClass)
+                raise StandardError, "Unable to convert #{value} to TrueClass or FalseClass"
+              when data_type == Symbol
+                value.to_sym
+              when data_type == Hash
+                JSON.parse value
+              when data_type == Array
+                JSON.parse value
+              else
+                file = factory_file(data_type)
+                data = data_from_yaml(file, value) || value
+                data_type.new(data)
+              end
+      return value if value.is_a?(data_type)
+      raise StandardError, "Unable to convert #{value} to #{data_type}"
+    end
+
     def convert(hash, *args)
       hash.deep_symbolize_keys!
       filtered = hash.reject { |k| !keys.include?(k) }
@@ -36,6 +87,27 @@ class WatirModel
       end
       model
     end
+
+    def default_directory
+      'config/data'
+    end
+
+    def method_missing(method, *args, &block)
+      file = factory_file(self)
+      return super unless file
+      data = data_from_yaml(file, method)
+      raise ArgumentError, "Factory '#{method}' does not exist in '#{file}'" if data.nil?
+      new(data)
+    end
+
+    def factory_file(type)
+      Dir.glob("#{WatirModel.yml_directory}/#{type.to_s.downcase}.yml").first
+    end
+
+    def data_from_yaml(file, value)
+      return nil unless !file.nil? || value.is_a?(Symbol) || value.is_a?(String)
+      YAML.load_file(file)[value.to_sym]
+    end
   end
 
   def initialize(hash={})
@@ -45,6 +117,7 @@ class WatirModel
     (self.class.defaults.keys - hash.keys).each do |key|
       block = self.class.defaults[key]
       value = default_value(key, block)
+      value = self.class.convert_type(key, value)
       instance_variable_set("@#{key}", value)
     end
   end
@@ -52,17 +125,27 @@ class WatirModel
   def update(hash)
     hash ||= {}
 
+    (hash.keys & aliases.keys).each do |alias_key|
+      hash[aliases[alias_key]] = hash.delete(alias_key)
+    end
+
     unknown = hash.keys - keys
     if unknown.count > 0
       raise ArgumentError, "unknown keyword#{'s' if unknown.count > 1}: #{unknown.join ', '}"
     end
-    hash.each { |key, v| instance_variable_set "@#{key}", v }
+    hash.each do |key, val|
+      instance_variable_set "@#{key}", self.class.convert_type(key, val)
+    end
   end
 
   def keys
     self.class.keys
   end
 
+  def aliases
+    self.class.aliases
+  end
+
   def [] key
     send key
   end

data/watir_model.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "watir_model"
-  spec.version       = "0.3.1"
+  spec.version       = "0.4.0"
   spec.authors       = ["Titus Fortner"]
   spec.email         = ["titusfortner@gmail.com"]
 
@@ -25,6 +25,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency 'activesupport'
+  spec.add_runtime_dependency 'yml_reader', '>= 0.6'
 
   spec.add_development_dependency "bundler", "~> 1.9"
   spec.add_development_dependency "rake", "~> 10.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: watir_model
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Titus Fortner
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-05-20 00:00:00.000000000 Z
+date: 2017-12-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: yml_reader
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +108,8 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- config/alternate/address.yml
+- config/data/address.yml
 - lib/config_model.rb
 - lib/watir_model.rb
 - watir_model.gemspec
@@ -118,7 +134,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: This is a simple class for modelling test data.