tardvig 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6d19399953954acf68f31e5a9fb17befd2599a4b
-  data.tar.gz: adeb97c978d563c469aee6490d317adf174569eb
+  metadata.gz: 9e5efc7f9212fc72c23ca3e0eb60ea50c41370b7
+  data.tar.gz: b471b0c34344b11fa98c475a18aebcac5ec20ea9
 SHA512:
-  metadata.gz: d219400808b22aad2ec4cb4c7d920af26b8b1227880b9b4f2292fa1c08a8df0434a8cdbf6b5e4a693f60987b12e1762389d74e3229443900a867b03b47bee594
-  data.tar.gz: 2cc8af78421f3b9877373b72993b10756703f5200c5f2aacb714e7398290d7502040a44f2a794bed415893baeb116420fed02f02911c5a859eca62f668a6307b
+  metadata.gz: 861878ba9b5a3fb3cc2cfd77dd3f3d6f6caab5dfd3c7ed805cc0866f89a43f60a9b4a50938fab37f7ef1ba7769f23d4976c9aa80914c5633c6b56ba9beeba626
+  data.tar.gz: 8a696bb84b3e59391b8fd087ff3ff454f8cb732e6ca66fe0bf934ff48f1ea8acfc58dd806aaf636fd30addcabc3fb2400f37129a52150a0a45cc63fcdcdea857

data/lib/tardvig/hash_container.rb

@@ -0,0 +1,91 @@
+module Tardvig
+  # It is container for data, which is similar to Ruby's Hash, but it has more
+  # narrow purpose and corresponding changes in the list of methods.
+  # It is not Enumerable, so it has no `sort` method, `each`, `map`, etc.
+  # It allows to read, write, delete elements, save itself to/load from a file 
+  # or IO, it has events and data identifier.
+  # **It is expected that you already know what is hash**.
+  #
+  # Events:
+  # * `save` happen before saving data to a file. Arguments: self
+  # * `load` happen after loading data from a file. Arguments: self
+  # * `change` happen when there are some objects have been 
+  #   deleted from/added to this container. Arguments: self
+  class HashContainer
+    include DataIdentifier
+    include Events
+    
+    # @param hash [Hash] default Ruby's Hash. 
+    #   If it is given, the container will be created from it (it will have the
+    #   same key => value pairs).
+    def initialize(hash = {})
+      @hash = hash
+    end
+
+    # @param key [Object] the object which you previously associated with value
+    # @return value associated with the given key through the {#[]=} method or
+    #   `nil` if there is no such value.
+    # @see #[]=
+    # @see Ruby's Hash
+    def [](key)
+      @hash[key]
+    end
+
+    # Adds your value to this container, so you can access it through the {#[]}
+    # method later using your key.
+    # @param key [Object] object which is used as an identifier of your value
+    # @param value [Object] anything you want to store in this container
+    # @return value
+    # @see Ruby's Hash
+    def []=(key, value)
+      @hash[key] = value
+      trigger :change, self
+      value
+    end
+
+    # Removes the given key and corresponding value from this container, so
+    # you can not access it further.
+    # @param (see #[])
+    # @return (see #[])
+    # @see Ruby's Hash
+    def delete(key)
+      value = @hash.delete key
+      trigger :change, self
+      value
+    end
+
+    # Saves this container's content to the file through YAML
+    # @param io [IO, String] the IO instance or the name of the file.
+    #   The content will be saved here.
+    def save(io)
+      open_file io, 'w' do |f|
+        trigger :save, self
+        f.write YAML.dump(@hash)
+      end
+    end
+
+    # Loads the data from the YAML file to itself. If there are old data in the
+    # hash, it overrides them.
+    # @param io [IO, String] the IO instance or the name of the file.
+    #   The data will be loaded from here.
+    def load(io)
+      open_file io, 'r' do |f|
+        @hash.merge! YAML.load(f.read)
+        trigger :load, self
+        trigger :change, self
+      end
+    end
+
+    private
+
+    def open_file(io, mode)
+      if io.respond_to?(:read) && io.respond_to?(:write)
+        yield io
+      elsif io.is_a? String
+        File.open(io, mode) { |f| yield f }
+      else
+        raise ArgumentError
+      end
+    end
+  end
+end

data/lib/tardvig/saved_hash.rb

@@ -8,6 +8,8 @@ module Tardvig
   # Events:
   # * `save` happen before saving data to a file. Arguments: the hash itself
   # * `load` happen after loading data from a file. Arguments: the hash itself
+  #
+  # @deprecated Use HashContainer instead.
   class SavedHash < Hash
     include Events
 

data/lib/tardvig/version.rb

@@ -1,3 +1,3 @@
 module Tardvig
-  VERSION = '0.2.1'.freeze
+  VERSION = '0.2.2'.freeze
 end

data/lib/tardvig.rb

@@ -9,6 +9,7 @@ require_relative 'tardvig/gameio.rb'
 require_relative 'tardvig/act.rb'
 require_relative 'tardvig/data_identifier.rb'
 require_relative 'tardvig/events/proxy.rb'
+require_relative 'tardvig/hash_container.rb'
 
 # The main namespace for the gem
 module Tardvig

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tardvig
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Vadim Saprykin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-24 00:00:00.000000000 Z
+date: 2016-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -84,6 +84,7 @@ files:
 - lib/tardvig/events.rb
 - lib/tardvig/events/proxy.rb
 - lib/tardvig/gameio.rb
+- lib/tardvig/hash_container.rb
 - lib/tardvig/saved_hash.rb
 - lib/tardvig/toolkit.rb
 - lib/tardvig/version.rb