hash_dot 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2a6e045e5ade1404d4e85300e3ecc4455860e499
-  data.tar.gz: c847967cc0e5063b6ac825ba3da135bdab9cccb8
+  metadata.gz: 93b55369f46856b6cf664ec018d705709370e07d
+  data.tar.gz: 70c5e0fca4d8e0646da79c68fae4dacaf1d97dea
 SHA512:
-  metadata.gz: a73bf2ca4e4977e8e9c180df33fd2468a0863144653b9b5608bf26f7568ded483fb22ada7b04dbd2df435775b56bc796cd12be2cd8c3e4986039a94eb217b845
-  data.tar.gz: 191181c73c3eda75736d3d5a8967f9ea78facea5144268a9a4abe6b3007700f48c5451965e6cdf53da4502991b8a176fbde607cd42c4a2e9a30f2262f9ce5ce0
+  metadata.gz: 85ab5a04cd496a674ac07c4b5c463317ea0a3068b01b22eccc9333ebf97178afd568234eda2d1b34a329ba7b85bfca42e1c35b2a512a177a17249ba36491883d
+  data.tar.gz: 64526817b4fc243431acc698ce4aabd60d43396f4c1e1041c75223ca4000762093f254a8126fec2f6d41c53e11fb8cc34419508b36662a1042817292015c03a3

data/README.md

@@ -1,13 +1,25 @@
 # HashDot
 
-HashDot allows you to call your Ruby hash properties with a dot syntax. Simply include the gem in your project and starting using the dot syntax.
+HashDot allows you to call your Ruby hash properties with a dot syntax.
 
 ```ruby
-  user = {name: 'Anna', job: {title: 'Programmer'}}
+  require 'hash_dot'
+
+  user = {name: 'Anna', job: {title: 'Programmer'}}.to_dot
 
   user.job.title #=> 'Programmer'
   user.job.title = 'Senior Programmer'
   user.job.title #=> 'Senior Programmer'
+  user.job.delete(:title)
+  user.job.title #=> NoMethodError
+```
+
+You can also allow dot syntax for all hashes via the class setting.
+
+```ruby
+Hash.use_dot_syntax = true
+
+{name: 'Pat'}.name #=> 'Pat'
 ```
 
 
@@ -28,9 +40,55 @@ Or install it yourself as:
     $ gem install hash_dot
 
 
+## Benchmarks
+Benchmarks should be taken with a grain of salt, as always. For example, OpenStruct is much slower to initialize, but calls its methods faster once initialized. The OpenStruct solution also can't traverse more than a single dot without recursively instantiating all sub-hashes into OpenStructs.
+
+```Ruby
+require 'ostruct'
+require 'benchmark'
+require 'hash_dot'
+
+user = { address: { category: { desc: 'Urban'}}}.to_dot
+
+iterations = 50000
+
+Benchmark.bm(8) do |bm|
+  bm.report("Default Notation   :") {
+    iterations.times do; user[:address][:category][:desc]; end
+  }
+
+  bm.report("Dot Notation       :") {
+    iterations.times do; user.address.category.desc; end
+  }
+
+  bm.report("OpenStruct         :") {
+    iterations.times do; OpenStruct.new(user); end
+  }
+
+  # Minus OpenStruct instantiation cost
+  os_user = OpenStruct.new(user)
+  bm.report("OpenStruct Single  :") {
+    iterations.times do; os_user.address; end
+  }
+
+  bm.report("Dot Notation Single:") {
+    iterations.times do; user.address; end
+  }
+end
+
+# Benchmark Example
+#                       user     system      total        real
+Default Notation   :  0.010000   0.000000   0.010000 (  0.008807)
+Dot Notation       :  0.190000   0.000000   0.190000 (  0.195819)
+OpenStruct         :  0.400000   0.010000   0.410000 (  0.399542)
+OpenStruct Single  :  0.010000   0.000000   0.010000 (  0.011259)
+Dot Notation Single:  0.080000   0.000000   0.080000 (  0.082606)
+```
+
+
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/adsteel/hash_dot. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/adsteel/hash_dot. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](CODE_OF_CONDUCT.md) code of conduct.
 
 
 ## License

data/hash_dot.gemspec

@@ -31,4 +31,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "json"
+  spec.add_development_dependency "pry"
 end

data/lib/hash.rb

@@ -0,0 +1,49 @@
+class Hash
+  class << self
+    attr_accessor :use_dot_syntax
+  end
+
+  attr_accessor :use_dot_syntax
+
+  def to_dot
+    dotify_hash(self)
+
+    self
+  end
+
+  def method_missing(method, *args)
+    return super(method, *args) unless to_dot?
+
+    prop = create_prop(method)
+
+    if self[prop].nil?
+      self[prop] = self.delete(prop.to_s)
+    end
+
+    super(method, args) and return if self[prop].nil?
+
+    if setter?(method)
+      self[prop] = args.first
+    else
+      self[prop]
+    end
+  end
+
+  private def dotify_hash(hash)
+    hash.use_dot_syntax = true
+
+    hash.keys.each { |key| dotify_hash(hash[key]) if hash[key].is_a?(Hash) }
+  end
+
+  private def to_dot?
+    self.use_dot_syntax || self.class.use_dot_syntax
+  end
+
+  private def setter?(method)
+    method.last == "="
+  end
+
+  private def create_prop(method)
+    setter?(method) ? method.chop : method
+  end
+end

data/lib/hash_dot.rb

@@ -1,41 +1,6 @@
 require "hash_dot/version"
-require 'json'
+require 'symbol'
+require 'hash'
 
-class Symbol
-  def chop
-    to_s.chop.to_sym
-  end
-
-  def last
-    slice(-1, 1)
-  end
-end
-
-class Hash
-  def method_missing(method, *args)
-    prop = create_prop(method)
-
-    if self[prop].nil?
-      self[prop] = self[prop.to_s]
-      self.delete(prop.to_s)
-    end
-
-    super(method, args) and return if self[prop].nil?
-
-    if setter?(method)
-      self[prop] = args.first
-    else
-      self[prop]
-    end
-  end
-
-  private
-
-  def setter?(method)
-    method.last == "="
-  end
-
-  def create_prop(method)
-    setter?(method) ? method.chop : method
-  end
+module HashDot
 end

data/lib/hash_dot/version.rb

@@ -1,3 +1,3 @@
 module HashDot
-  VERSION = "1.0.0"
+  VERSION = "2.0.0"
 end

data/lib/symbol.rb

@@ -0,0 +1,9 @@
+class Symbol
+  def chop
+    to_s.chop.to_sym
+  end
+
+  def last
+    slice(-1, 1)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hash_dot
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Adam Steel
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-06-14 00:00:00.000000000 Z
+date: 2015-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: HashDot allows you to call hash properties with a dot the same way you
   would call, say, ActiveRecord relationships and attributes. More traversable and
   often faster than OpenStruct.
@@ -86,8 +100,10 @@ files:
 - bin/console
 - bin/setup
 - hash_dot.gemspec
+- lib/hash.rb
 - lib/hash_dot.rb
 - lib/hash_dot/version.rb
+- lib/symbol.rb
 homepage: https://github.com/adsteel/hash_dot
 licenses:
 - MIT
@@ -109,7 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Use dot syntax with Ruby hashes.