rubysl-yaml 1.1.0 → 2.0.0

data/lib/yaml/dbm.rb

@@ -1,23 +1,52 @@
 require 'yaml'
 require 'dbm'
-#
-# YAML + DBM = YDBM
-# - Same interface as DBM class
-#
+
 module YAML
 
+# YAML + DBM = YDBM
+#
+# YAML::DBM provides the same interface as ::DBM.
+#
+# However, while DBM only allows strings for both keys and values,
+# this library allows one to use most Ruby objects for values
+# by first converting them to YAML. Keys must be strings.
+#
+# Conversion to and from YAML is performed automatically.
+#
+# See the documentation for ::DBM and ::YAML for more information.
 class DBM < ::DBM
     VERSION = "0.1"
+
+    # Return value associated with +key+ from database.
+    #
+    # Returns +nil+ if there is no such +key+.
     def []( key )
         fetch( key )
     end
+
+    # :call-seq:
+    #   []=( key, value )
+    #
+    # Set +key+ to +value+ in database.
+    #
+    # +value+ will be converted to YAML before storage.
     def []=( key, val )
         store( key, val )
     end
+
+    # :call-seq:
+    #   fetch( key, ifnone = nil )
+    #   fetch( key, &block )
+    #
+    # Return value associated with +key+.
+    #
+    # If there is no value for +key+ and no block is given, returns +ifnone+.
+    #
+    # Otherwise, calls block passing in the given +key+.
     def fetch( keystr, ifnone = nil )
         begin
             val = super( keystr )
-            return YAML::load( val ) if String === val
+            return YAML.load( val ) if String === val
         rescue IndexError
         end
         if block_given?
@@ -26,58 +55,110 @@ class DBM < ::DBM
             ifnone
         end
     end
+
+    # Deprecated, used YAML::DBM#key instead.
     def index( keystr )
         super( keystr.to_yaml )
     end
+
+    # Returns an array containing the values associated with the given keys.
     def values_at( *keys )
         keys.collect { |k| fetch( k ) }
     end
+
+    # Deletes value from database associated with +key+.
+    #
+    # Returns value or +nil+.
     def delete( key )
         v = super( key )
         if String === v
-            v = YAML::load( v ) 
+            v = YAML.load( v )
         end
         v
     end
-    def delete_if
+
+    # Calls the given block once for each +key+, +value+ pair in the database.
+    # Deletes all entries for which the block returns true.
+    #
+    # Returns +self+.
+    def delete_if # :yields: [key, value]
         del_keys = keys.dup
         del_keys.delete_if { |k| yield( k, fetch( k ) ) == false }
-        del_keys.each { |k| delete( k ) } 
+        del_keys.each { |k| delete( k ) }
         self
     end
+
+    # Converts the contents of the database to an in-memory Hash, then calls
+    # Hash#reject with the specified code block, returning a new Hash.
     def reject
         hsh = self.to_hash
         hsh.reject { |k,v| yield k, v }
     end
-    def each_pair
+
+    # Calls the given block once for each +key+, +value+ pair in the database.
+    #
+    # Returns +self+.
+    def each_pair # :yields: [key, value]
         keys.each { |k| yield k, fetch( k ) }
         self
     end
-    def each_value
-        super { |v| yield YAML::load( v ) }
+
+    # Calls the given block for each value in database.
+    #
+    # Returns +self+.
+    def each_value # :yields: value
+        super { |v| yield YAML.load( v ) }
         self
     end
+
+    # Returns an array of values from the database.
     def values
-        super.collect { |v| YAML::load( v ) }
+        super.collect { |v| YAML.load( v ) }
     end
+
+    # Returns true if specified value is found in the database.
     def has_value?( val )
         each_value { |v| return true if v == val }
         return false
     end
+
+    # Returns a Hash (not a DBM database) created by using each value in the
+    # database as a key, with the corresponding key as its value.
+    #
+    # Note that all values in the hash will be Strings, but the keys will be
+    # actual objects.
     def invert
         h = {}
         keys.each { |k| h[ self.fetch( k ) ] = k }
         h
     end
+
+    # Replaces the contents of the database with the contents of the specified
+    # object. Takes any object which implements the each_pair method, including
+    # Hash and DBM objects.
     def replace( hsh )
         clear
         update( hsh )
     end
+
+    # Removes a [key, value] pair from the database, and returns it.
+    # If the database is empty, returns +nil+.
+    #
+    # The order in which values are removed/returned is not guaranteed.
     def shift
         a = super
-        a[1] = YAML::load( a[1] ) if a
+        a[1] = YAML.load( a[1] ) if a
         a
     end
+
+    # :call-seq:
+    #   select( &block )
+    #   select( *keys )
+    #
+    # If a block is provided, returns a new array containing [key, value] pairs
+    # for which the block returns true.
+    #
+    # Otherwise, same as #values_at
     def select( *keys )
         if block_given?
             self.keys.collect { |k| v = self[k]; [k, v] if yield k, v }.compact
@@ -85,26 +166,48 @@ class DBM < ::DBM
             values_at( *keys )
         end
     end
+
+    # :call-seq:
+    #   store( key, value )
+    #
+    #Stores +value+ in database with +key+ as the index. +value+ is converted
+    #to YAML before being stored.
+    #
+    #Returns +value+
     def store( key, val )
         super( key, val.to_yaml )
         val
     end
+
+    # Updates the database with multiple values from the specified object.
+    # Takes any object which implements the each_pair method, including
+    # Hash and DBM objects.
+    #
+    # Returns +self+.
     def update( hsh )
         hsh.keys.each do |k|
             self.store( k, hsh.fetch( k ) )
         end
         self
     end
+
+    # Converts the contents of the database to an array of [key, value] arrays,
+    # and returns it.
     def to_a
         a = []
         keys.each { |k| a.push [ k, self.fetch( k ) ] }
         a
     end
+
+
+    # Converts the contents of the database to an in-memory Hash object, and
+    # returns it.
     def to_hash
         h = {}
         keys.each { |k| h[ k ] = self.fetch( k ) }
         h
     end
+
     alias :each :each_pair
 end
 

data/lib/yaml/store.rb

@@ -4,9 +4,50 @@
 require 'yaml'
 require 'pstore'
 
+# YAML::Store provides the same functionality as PStore, except it uses YAML
+# to dump objects instead of Marshal.
+#
+# == Example
+#
+#   require 'yaml/store'
+#
+#   Person = Struct.new :first_name, :last_name
+#
+#   people = [Person.new("Bob", "Smith"), Person.new("Mary", "Johnson")]
+#
+#   store = YAML::Store.new "test.store"
+#
+#   store.transaction do
+#     store["people"] = people
+#     store["greeting"] = { "hello" => "world" }
+#   end
+#
+# After running the above code, the contents of "test.store" will be:
+#
+#   ---
+#   people:
+#   - !ruby/struct:Person
+#     first_name: Bob
+#     last_name: Smith
+#   - !ruby/struct:Person
+#     first_name: Mary
+#     last_name: Johnson
+#   greeting:
+#     hello: world
+
 class YAML::Store < PStore
+
+  # :call-seq:
+  #   initialize( file_name, yaml_opts = {} )
+  #
+  # Creates a new YAML::Store object, which will store data in +file_name+.
+  # If the file does not already exist, it will be created.
+  #
+  #
+  # Options passed in through +yaml_opts+ will be used when converting the
+  # store to YAML via Hash#to_yaml().
   def initialize( *o )
-    @opt = YAML::DEFAULTS.dup
+    @opt = {}
     if String === o.first
       super(o.shift)
     end
@@ -15,12 +56,14 @@ class YAML::Store < PStore
     end
   end
 
+  # :stopdoc:
+
   def dump(table)
     @table.to_yaml(@opt)
   end
 
   def load(content)
-    table = YAML::load(content)
+    table = YAML.load(content)
     if table == false
       {}
     else

data/lib/yaml/syck.rb

@@ -1,44 +1,53 @@
+# $Id$
 #
-# YAML::Syck module
-# .. glues syck and yaml.rb together ..
+# = yaml/syck.rb:
 #
-require 'syck/syck'
-require 'yaml/basenode'
-
-module YAML
-    module Syck
 
-        #
-        # Mixin BaseNode functionality
-        #
-        class Node
-            include YAML::BaseNode
-        end
+require 'stringio'
+require 'syck/ext/syck'
+require 'syck/error'
+require 'syck/syck'
+require 'syck/tag'
+require 'syck/stream'
+require 'syck/constants'
+require 'syck/rubytypes'
+require 'syck/types'
 
-        #--
-        # For Rubinius, replaces the rb_iterate call to syck_set_ivars.
-        #++
-        def self.set_ivars(hsh, obj)
-          hsh.each do |key, value|
-            obj.instance_variable_set :"@#{key}", value
-          end
-        end
+module Syck
+  #--
+  # For Rubinius, replaces the rb_iterate call to syck_set_ivars.
+  #++
+  def self.set_ivars(hsh, obj)
+    hsh.each do |key, value|
+      obj.instance_variable_set :"@#{key}", value
+    end
+  end
 
-        #--
-        # For Rubinius, replaces the rb_iterate call to syck_merge_i.
-        #++
-        def self.merge_i(ary, hsh)
-          ary.each do |entry|
-            begin
-              entry = Rubinius::Type.coerce_to entry, Hash, :to_hash
-              hsh.update entry
-            rescue
-              # ignore coercion errors
-            end
-          end
+  #--
+  # For Rubinius, replaces the rb_iterate call to syck_merge_i.
+  #++
+  def self.merge_i(ary, hsh)
+    ary.each do |entry|
+      begin
+        entry = Rubinius::Type.coerce_to entry, Hash, :to_hash
+        hsh.update entry
+      rescue
+        # ignore coercion errors
+      end
+    end
 
-          nil
-        end
+    nil
+  end
 
+  #--
+  # For Rubinius, replaces rb_syck_mktime.
+  #++
+  def self.mktime(str)
+    require "date"
+    begin
+      DateTime.parse(str).to_time
+    rescue ArgumentError
+      # nothing
     end
+  end
 end

data/rubysl-yaml.gemspec

@@ -13,14 +13,12 @@ Gem::Specification.new do |spec|
 
   spec.files         = `git ls-files`.split($/)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.extensions    = ["ext/rubysl/syck/extconf.rb"]
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = "~> 1.8.7"
+  spec.required_ruby_version = "~> 2.0"
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "mspec", "~> 1.5"
-  spec.add_development_dependency "rubysl-prettyprint", "~> 1.0"
 end

metadata

@@ -1,121 +1,77 @@
 --- !ruby/object:Gem::Specification
 name: rubysl-yaml
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Brian Shirai
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-16 00:00:00.000000000 Z
+date: 2013-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
-  prerelease: false
   type: :development
-- !ruby/object:Gem::Dependency
-  name: rake
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
-  prerelease: false
   type: :development
-- !ruby/object:Gem::Dependency
-  name: mspec
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: mspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.5'
-  prerelease: false
   type: :development
-- !ruby/object:Gem::Dependency
-  name: rubysl-prettyprint
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '1.0'
-  prerelease: false
-  type: :development
+        version: '1.5'
 description: Ruby standard library YAML.
 email:
 - brixen@gmail.com
 executables: []
-extensions:
-- ext/rubysl/syck/extconf.rb
+extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".travis.yml"
+- .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
-- ext/rubysl/syck/bytecode.c
-- ext/rubysl/syck/emitter.c
-- ext/rubysl/syck/extconf.rb
-- ext/rubysl/syck/gram.c
-- ext/rubysl/syck/gram.h
-- ext/rubysl/syck/handler.c
-- ext/rubysl/syck/implicit.c
-- ext/rubysl/syck/node.c
-- ext/rubysl/syck/rubyext.c
-- ext/rubysl/syck/st.c
-- ext/rubysl/syck/st.h
-- ext/rubysl/syck/syck.c
-- ext/rubysl/syck/syck.h
-- ext/rubysl/syck/token.c
-- ext/rubysl/syck/yaml2byte.c
-- ext/rubysl/syck/yamlbyte.h
 - lib/rubysl/yaml.rb
 - lib/rubysl/yaml/version.rb
 - lib/rubysl/yaml/yaml.rb
 - lib/yaml.rb
-- lib/yaml/baseemitter.rb
-- lib/yaml/basenode.rb
-- lib/yaml/constants.rb
 - lib/yaml/dbm.rb
-- lib/yaml/encoding.rb
-- lib/yaml/error.rb
-- lib/yaml/loader.rb
-- lib/yaml/rubytypes.rb
 - lib/yaml/store.rb
-- lib/yaml/stream.rb
-- lib/yaml/stringio.rb
 - lib/yaml/syck.rb
-- lib/yaml/tag.rb
-- lib/yaml/types.rb
-- lib/yaml/yamlnode.rb
-- lib/yaml/ypath.rb
 - rubysl-yaml.gemspec
 - spec/add_builtin_type_spec.rb
 - spec/add_domain_type_spec.rb
@@ -160,17 +116,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ~>
     - !ruby/object:Gem::Version
-      version: 1.8.7
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.0.7
 signing_key: 
 specification_version: 4
 summary: Ruby standard library YAML.
@@ -208,4 +164,3 @@ test_files:
 - spec/to_yaml_spec.rb
 - spec/transfer_spec.rb
 - spec/try_implicit_spec.rb
-has_rdoc: