reference_book 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d4b6a7b22b35c94188e41157711d44416a1d61b0
-  data.tar.gz: 952b181d58f07a5b749df7d5c4b2246bec84d1b1
+  metadata.gz: 8c3e7c15bc3227796acd8da604609317be256da9
+  data.tar.gz: 314b8f545ee5d8ed14c609d71b48fdabe2bc0436
 SHA512:
-  metadata.gz: cc53552201efb3701cd427a90b90030438505c62f420d9f1e5531fe279d0b5b3ab16e042cd6a0d501e58de93e161ca4ab3c6ce34477ccdb25aeafe494719ef77
-  data.tar.gz: 54d77729f7193df83f9b207b847881b176edcee6d893b5bd47641b991e5e03268164347cecd8ad5988a2bd67588241f9fbddd8e90e1aed9af2f10aea9b71e0c9
+  metadata.gz: ed7a48d91de0c053d0b5ff30cb0257a30ac9ce0e4dc9654bdd0928dc7fa6eff63d00d61c00dab16f54513b1348f228ecd6e40ea89ff706b581077a2aef9f9c1c
+  data.tar.gz: 77016384a101956dfc1b0ffcd2c9135ac42dd9eefca02fe1cf2b68c2e830827abc308148a604d5188669fba59bc50be857263fb6519442746bbab9a7122af45e

data/examples/interface_and_use.rb

@@ -80,6 +80,59 @@ ReferenceBook.library.hash_for :constitution
 
 
 
+# and complete serializations to Ruby
+ReferenceBook.library.to_h
+# => { :elf => { :strength => 0,
+#                :dexterity => 2,
+#                :constitution => -2,
+#                :intelligence => 0,
+#                :wisdom => 0,
+#                :charisma => 0 },
+#      :dwarf => { :strength => 0,
+#                  :dexterity => 0,
+#                  :constitution => 2,
+#                  :intelligence => 0,
+#                  :wisdom => 0,
+#                  :charisma => -2 },
+#      :halfling => { :strength => -2,
+#                     :dexterity => 2,
+#                     :constitution => 0,
+#                     :intelligence => 0,
+#                     :wisdom => 0,
+#                     :charisma => 0 }
+#     }
+
+# You can pass 'true' to include 'title' and 'library_key' to the serialized results
+ReferenceBook.library.to_h(true)
+# => { :elf => { # ...like the one above, plus:
+#                :title => "Elf",
+#                :library_key => :elf },
+#      :dwarf => { # ...like the one above, plus:
+#                  :title => "Dwarf",
+#                  :library_key => :dwarf },
+#      :halfling => { # ...like the one above, plus:
+#                     :title => "Halfling",
+#                     :library_key => :halfling }
+#    }
+
+
+ReferenceBook.library.rotate
+# => { :strength => {:elf => 0, :dwarf => 0, :halfling => -2},
+#      :dexterity => {:elf => 2, :dwarf => 0, :halfling => 2},
+#      :constitution => {:elf => -2, :dwarf => 2, :halfling => 0},
+#      :intelligence => {:elf => 0, :dwarf => 0, :halfling => 0},
+#      :wisdom => {:elf => 0, :dwarf => 0, :halfling => 0},
+#      :charisma => {:elf => 0, :dwarf => -2, :halfling => 0}}
+
+
+# You can pass 'true' to include 'title' and 'library_key' to the serialized results
+ReferenceBook.library.rotate(true)
+# => { # ...like the one above, plus:
+#      :title => {:elf => "Elf", :dwarf => "Dwarf", :halfling => "Halfling"},
+#      :library_key => {:elf => :elf, :dwarf => :dwarf, :halfling => :halfling}}
+
+
+
 
 # You can wrap it with your own logic:
 

data/lib/reference_book/book.rb

@@ -1,2 +1,16 @@
 class ReferenceBook::Book < Struct
+
+  # To hide a book's meta attributes.
+  #
+  # Since it would be necessary to override almost all methods,
+  # it would be better to drop the inheritance and switch to
+  # composition, with the Struct (or a Hash) as a private member.
+  #
+  # def to_h
+  #   h = super
+  #   h.delete(:title)
+  #   h.delete(:library_key)
+  #   h
+  # end
+
 end

data/lib/reference_book/library.rb

@@ -42,6 +42,20 @@ module ReferenceBook::Library
 
 
 
+    def book_keys
+      return @book_keys if @book_keys
+      
+      if index.any?
+        @book_keys = shelf.map { |k, book| book.members }.flatten.uniq
+        @book_keys.delete(:title)
+        @book_keys.delete(:library_key)
+        @book_keys
+      else
+        []
+      end
+    end
+
+
 
     def array_for(attribute)
       shelf.map do |key, book|
@@ -62,6 +76,48 @@ module ReferenceBook::Library
 
 
 
+
+    def to_h(with_meta = false)
+      hash = {}
+
+      shelf.each do |key, book|
+        book_h = book.to_h
+        
+        unless with_meta
+          book_h.delete(:title)
+          book_h.delete(:library_key)
+        end
+
+        missing = book_keys - book_h.keys
+        missing.each do |k|
+          book_h[k] = nil
+        end
+
+        hash[key] = book_h
+      end
+
+      hash
+    end
+
+
+
+
+    def rotate(with_meta = false)
+      hash = Hash[
+        book_keys.map do |book_k|
+          [book_k, hash_for(book_k)]
+        end
+      ]
+
+      if with_meta
+        hash[:title] = hash_for(:title)
+        hash[:library_key] = hash_for(:library_key)
+      end
+
+      hash
+    end
+
+
   private
 
     def define_accessor_for(book)

data/lib/reference_book/version.rb

@@ -1,3 +1,3 @@
 module ReferenceBook
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/test/book_test.rb

@@ -2,7 +2,7 @@ require 'test_helper'
 
 class BookTest < Minitest::Test
 
-  BOOK_STRUCT = ReferenceBook::Book.new("Example", :foo, :bar)
+  BOOK_STRUCT = ReferenceBook::Book.new("Example", :foo, :bar, :title, :library_key)
 
   def setup
     super
@@ -56,7 +56,7 @@ class BookTest < Minitest::Test
 
 
   def test_creation
-    template = ReferenceBook::Book.new("Foobar", :foo, :bar)
+    template = ReferenceBook::Book.new("Foobar", :foo, :bar, :title, :library_key)
     assert_equal Class, template.class
     assert_equal "ReferenceBook::Book::Foobar", template.name
 
@@ -72,9 +72,12 @@ class BookTest < Minitest::Test
 
   def test_to_h
     assert_equal Hash, @book.to_h.class
-    assert_equal 2, @book.to_h.size
+    assert_equal 4, @book.to_h.size
     assert_includes @book.to_h.keys, :foo
     assert_includes @book.to_h.keys, :bar
+    assert_includes @book.to_h.keys, :title
+    assert_includes @book.to_h.keys, :library_key
+    
     assert_nil @book.to_h[:foo]
     assert_nil @book.to_h[:bar]
 

data/test/library_test.rb

@@ -153,21 +153,7 @@ class LibraryTest < Minitest::Test
 
 
   def test_pluck
-    ReferenceBook.write_book(title: "TestPluckA") do |b|
-      b.foo = 11
-      b.bar = 22
-    end
-
-    ReferenceBook.write_book(title: "TestPluckB") do |b|
-      b.foo = 111
-      b.bar = 222
-      b.baz = 333
-    end
-
-    ReferenceBook.write_book(title: "TestPluckC") do |b|
-      b.foo = 1111
-      b.bar = 2222
-    end
+    end_to_end_setup("TestPluck")
 
     result = ReferenceBook.library.pluck(:foo)
     assert_instance_of Array, result
@@ -188,21 +174,7 @@ class LibraryTest < Minitest::Test
 
 
   def test_hash_pluck
-    ReferenceBook.write_book(title: "TestHashPluckA", library_key: :aaa) do |b|
-      b.foo = 11
-      b.bar = 22
-    end
-
-    ReferenceBook.write_book(title: "TestHashPluckB", library_key: :bbb) do |b|
-      b.foo = 111
-      b.bar = 222
-      b.baz = 333
-    end
-
-    ReferenceBook.write_book(title: "TestHashPluckC", library_key: :ccc) do |b|
-      b.foo = 1111
-      b.bar = 2222
-    end
+    end_to_end_setup("TestHashPluck")
 
     result = ReferenceBook.library.hash_pluck(:foo)
     assert_instance_of Hash, result
@@ -213,7 +185,6 @@ class LibraryTest < Minitest::Test
 
     assert_equal result, ReferenceBook.library.hash_for(:foo)
 
-
     result = ReferenceBook.library.hash_pluck(:baz)
     assert_instance_of Hash, result
     assert_equal 3, result.size
@@ -225,6 +196,68 @@ class LibraryTest < Minitest::Test
   end
 
 
+
+  def test_to_h_no_meta
+    end_to_end_setup("TestTohNoMeta")
+
+    result = ReferenceBook.library.to_h
+
+    assert_instance_of Hash, result
+    assert_equal 3, result.size
+
+    assert_equal({foo: 11, bar: 22, baz: nil},     result[:aaa])
+    assert_equal({foo: 111, bar: 222, baz: 333},   result[:bbb])
+    assert_equal({foo: 1111, bar: 2222, baz: nil}, result[:ccc])
+  end
+
+
+  def test_to_h_with_meta
+    end_to_end_setup("TestToH")
+
+    result = ReferenceBook.library.to_h(true)
+
+    assert_instance_of Hash, result
+    assert_equal 3, result.size
+
+    assert_equal({foo: 11, bar: 22, baz: nil, title: "TestToHA", library_key: :aaa},     result[:aaa])
+    assert_equal({foo: 111, bar: 222, baz: 333, title: "TestToHB", library_key: :bbb},   result[:bbb])
+    assert_equal({foo: 1111, bar: 2222, baz: nil, title: "TestToHC", library_key: :ccc}, result[:ccc])
+  end
+
+
+
+  def test_rotate_no_meta
+    end_to_end_setup("TestRotateNoMeta")
+
+    result = ReferenceBook.library.rotate
+
+    assert_instance_of Hash, result
+    assert_equal 3, result.size
+
+    assert_equal({aaa: 11, bbb: 111, ccc: 1111}, result[:foo])
+    assert_equal({aaa: 22, bbb: 222, ccc: 2222}, result[:bar])
+    assert_equal({aaa: nil, bbb: 333, ccc: nil}, result[:baz])
+  end
+
+
+  def test_rotate_with_meta
+    end_to_end_setup("TestRotate")
+
+    result = ReferenceBook.library.rotate(true)
+
+    assert_instance_of Hash, result
+    assert_equal 5, result.size
+
+    assert_equal({aaa: 11, bbb: 111, ccc: 1111}, result[:foo])
+    assert_equal({aaa: 22, bbb: 222, ccc: 2222}, result[:bar])
+    assert_equal({aaa: nil, bbb: 333, ccc: nil}, result[:baz])
+
+    assert_equal({aaa: "TestRotateA", bbb: "TestRotateB", ccc: "TestRotateC"}, result[:title])
+    assert_equal({aaa: :aaa, bbb: :bbb, ccc: :ccc}, result[:library_key])
+  end
+
+
+
 private
   
   BOOK_STRUCT = ReferenceBook::Book.new("ExampleLib", :title, :library_key)
@@ -237,4 +270,24 @@ private
   end
 
 
+
+  def end_to_end_setup(base_name)
+    ReferenceBook.write_book(title: "#{base_name}A", library_key: :aaa) do |b|
+      b.foo = 11
+      b.bar = 22
+    end
+
+    ReferenceBook.write_book(title: "#{base_name}B", library_key: :bbb) do |b|
+      b.foo = 111
+      b.bar = 222
+      b.baz = 333
+    end
+
+    ReferenceBook.write_book(title: "#{base_name}C", library_key: :ccc) do |b|
+      b.foo = 1111
+      b.bar = 2222
+    end
+  end
+
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reference_book
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Tommaso Pavese