using_yaml 1.1.0 → 1.1.1

data/README.rdoc

@@ -82,6 +82,33 @@ By default, UsingYAML will return nil for missing files. It will also complain o
 
   UsingYAML.squelch!
 
+== Benchmark
+
+There are two extremes when navigating hashes. Either we hit a nil
+early, or we traverse successfully to the end. UsingYAML performs well regardless. Here are results using `ruby-1.8.7-p249 [ x86_64 ]`
+
+=== Testing chains of nils
+
+              user     system      total        real
+  normal      0.920000   0.040000   0.960000 (  0.980095)
+  chained     0.900000   0.060000   0.960000 (  0.973219)
+
+=== Testing where the keys exist
+
+              user     system      total        real
+  normal      2.780000   0.150000   2.930000 (  2.930808)
+  chained     0.960000   0.060000   1.020000 (  1.031477)
+
+=== Results
+
+While there are certainly other things to test, these benchmarks show
+that the method chaining performs either almost as well (in the case
+of nil.nil..) or significantly better (in the case of key.key..).
+
+I'd definitely like to do some more testing. However, this is
+primarily a convenience library to improve programmer happiness, so
+these tests have made me happy enough for now.
+
 == Note on Patches/Pull Requests
  
 * Fork the project.

data/Rakefile

@@ -51,6 +51,15 @@ task :benchmark do
   p = Person.new
   p.children # "cache" the nil
   n = 10000
+
+  puts "** Testing chains of nils **"
+  Benchmark.bmbm(10) do |x|
+    x.report("normal")  { n.times do; p.children && p.children['something'] && p.children['invalid']; end }
+    x.report("chained") { n.times do; p.children.something.invalid; end }
+  end
+
+  p.children = { 'something' => { 'valid' => 1 } }
+  puts "\n** Testing where the keys exist **"
   Benchmark.bmbm(10) do |x|
     x.report("normal")  { n.times do; p.children && p.children['something'] && p.children['invalid']; end }
     x.report("chained") { n.times do; p.children.something.invalid; end }

data/VERSION

@@ -1 +1 @@
-1.1.0
+1.1.1

data/lib/using_yaml.rb

@@ -22,7 +22,12 @@ end
 #
 # See +using_yaml+ for usage information.
 module UsingYAML
-  NilClass = add_nilclass_extensions(nil, nil)
+  NilExt   = Module.new do
+    define_method(:method_missing) do |*args|
+      self
+    end
+  end
+  NilClass = nil.extend(NilExt)
   
   class << self
     # Extends the incoming Array/Hash with magic which makes it
@@ -35,11 +40,7 @@ module UsingYAML
       when Hash
         add_hash_extensions(object, pathname)
       when ::NilClass
-        if pathname
-          add_nilclass_extensions(object, pathname)
-        else
-          UsingYAML::NilClass
-        end
+        UsingYAML::NilClass
       end
             
       object

data/lib/using_yaml/array.rb

@@ -2,29 +2,22 @@ module UsingYAML
   # Calls add_extensions on all children. Also defines a +save+ method
   # iff this is a top-level UsingYAML object (see below for details).
   def self.add_array_extensions(array, pathname)
-    # Here we define a Module to extend the array
-    extensions = Module.new do
-      # Iterate over the items
-      array.each do |item|
-        # Recursively continue to extend.
-        UsingYAML.add_extensions(item)
-      end
-      
-      # Define a save method if a pathname was supplied (only happens
-      # on the top-level object - that is, example.foo will have a
-      # +save+, but example.foo.bar will not).
-      if pathname
-        define_method(:save) do
-          # Serialise using +to_yaml+
-          File.open(pathname, 'w') do |f|
-            f.puts self.to_yaml
-          end
-        end
-      end
+    # Iterate over the items
+    array.each do |item|
+      # Recursively continue to extend.
+      UsingYAML.add_extensions(item)
     end
-
+    
     # Load in the extensions for this instance
-    array.extend(extensions)
+    array.instance_eval <<-RUBY
+      def save
+        # Serialise using +to_yaml+
+        File.open("#{pathname}", 'w') do |f|
+          f.puts self.to_yaml
+        end
+      end
+    RUBY
+  
     array
   end
 end

data/lib/using_yaml/hash.rb

@@ -2,14 +2,13 @@ module UsingYAML
   # Calls add_extensions on all children. Also defines a +save+ method
   # iff this is a top-level UsingYAML object (see below for details).
   def self.add_hash_extensions(hash, pathname)
-    # Here we define a Module to extend the hash
-    extensions = Module.new do
-      # Recursively continue to extend.
-      hash.each_pair do |key, value|
-        UsingYAML.add_extensions(value)
-      end
+    # Recursively continue to extend.
+    hash.each_pair do |key, value|
+      UsingYAML.add_extensions(value)
+    end
 
-      define_method(:method_missing) do |*args|
+    hash.instance_eval <<-RUBY
+      def method_missing(*args)
         name = args.shift.to_s
 
         if args.empty?
@@ -21,39 +20,30 @@ module UsingYAML
           # consistently with the other key-value pairs.
           key   = $1
           value = args.first
-
+      
           # Save the value in the hashtable
           send(:[]=, key, UsingYAML.add_extensions(value))
-
-          # Define the new reader (as above)
-          new_reader_extension = Module.new do
-            define_method(key) do
-              send(:[], key) || UsingYAML.add_extensions(nil)
-            end
-          end
-          extend(new_reader_extension)
-
           value
         else
           super(name, args)
         end
       end
+    RUBY
 
-      # Define a save method if a pathname was supplied (only happens
-      # on the top-level object - that is, example.foo will have a
-      # +save+, but example.foo.bar will not).
-      if pathname
-        define_method(:save) do
+    # Define a save method if a pathname was supplied (only happens
+    # on the top-level object - that is, example.foo will have a
+    # +save+, but example.foo.bar will not).
+    if pathname
+      hash.instance_eval <<-RUBY
+        def save 
           # Serialise using +to_yaml+
-          File.open(pathname, 'w') do |f|
+          File.open("#{pathname}", 'w') do |f|
             f.puts self.to_yaml
           end
         end
-      end
+      RUBY
     end
-
-    # Load in the extensions for this instance
-    hash.extend(extensions)
+    
     hash
   end
 end

data/using_yaml.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{using_yaml}
-  s.version = "1.1.0"
+  s.version = "1.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Marc Bowes"]
-  s.date = %q{2010-03-30}
+  s.date = %q{2010-04-21}
   s.description = %q{"Load, save and use YAML files as if they were objects"}
   s.email = %q{marcbowes@gmail.com}
   s.extra_rdoc_files = [
@@ -26,7 +26,6 @@ Gem::Specification.new do |s|
      "lib/using_yaml.rb",
      "lib/using_yaml/array.rb",
      "lib/using_yaml/hash.rb",
-     "lib/using_yaml/nilclass.rb",
      "spec/spec_helper.rb",
      "spec/using_yaml/path_spec.rb",
      "spec/using_yaml/using_yaml_spec.rb",

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 1
   - 1
-  - 0
-  version: 1.1.0
+  - 1
+  version: 1.1.1
 platform: ruby
 authors: 
 - Marc Bowes
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-30 00:00:00 +02:00
+date: 2010-04-21 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -48,7 +48,6 @@ files:
 - lib/using_yaml.rb
 - lib/using_yaml/array.rb
 - lib/using_yaml/hash.rb
-- lib/using_yaml/nilclass.rb
 - spec/spec_helper.rb
 - spec/using_yaml/path_spec.rb
 - spec/using_yaml/using_yaml_spec.rb

data/lib/using_yaml/nilclass.rb

@@ -1,34 +0,0 @@
-module UsingYAML
-  def self.add_nilclass_extensions(instance, pathname)
-    extensions = Module.new do
-      define_method(:method_missing) do |*args|
-        # Child objects should not have #save
-        if respond_to? :save
-          UsingYAML::NilClass
-        else
-          # One nil is the same as the next :)
-          self
-        end
-      end
-      
-      # Define a save method if a pathname was supplied (only happens
-      # on the top-level object - that is, example.foo will have a
-      # +save+, but example.foo.bar will not).
-      if pathname
-        # Being nil translates to "no file", not to "empty file", so we
-        # want to actually delete any existing file. This is a semantic
-        # difference, but important: there is a huge different between
-        # an _empty_ file and a _non-existant_ file. YAML does not
-        # reflect this difference, so we do.
-        define_method(:save) do
-          # If we can't delete it (permissions, ENOENT..), then there
-          # ain't much we can do, so just squelch the error.
-          FileUtils.rm(pathname) rescue nil
-        end
-      end
-    end
-
-    instance.extend(extensions)
-    instance
-  end
-end