metahash-rb 1.0.4 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 798330d85a54d6b19e38d12e21bc34c61584ef3d
-  data.tar.gz: fd78187595fcbd822ff50808d0b7fd1b60c76ba3
+  metadata.gz: c50e809216c3a73ef2046daea65464fa70523202
+  data.tar.gz: 24b5731caac076b56137652e1aef1811eb7af6e3
 SHA512:
-  metadata.gz: 0054823568ecbd5370c4cbeae8defb83ce057b8ae6cf52aa158c8454076cce61f0ef176c36063644d12f5192f09126f0ec0d2fb8c59139d2ce0ca93b2d4b263d
-  data.tar.gz: e3254e4a03ecb41c76d84e028b288855375f276e9fb9ea58c2e39f970dc63327934364c9ce540f45d20c6b35f36898fa14a5dbb2d0c2c21d15531dfc2c66337a
+  metadata.gz: 229d38b0eb040f5bc90e6eed6f2e173411647b1195d5544c0aeb1f3dc632f0f81dfb7d7a637b5b879f2de74c7d8dece3f71bf1e53e981df03799a962b024397d
+  data.tar.gz: d4c9b695e64e7ebb188997f1b0491e5e27268a838c9e1f7b902c8837f6801faa31c14cfed2727a4bb068209ffa3fda762996b33df5caed284bb328236144046a

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+bundler_args: --without guard
+rvm:
+  - "2.0"
+  - "2.1"
+  - "2.1.1"
+  - ruby-head
+script: "bundle exec rspec"
+addons:
+  code_climate:
+    repo_token: 1d1b1a31bb3137d986297ad8a1ad5a3a1adbd70f0e8583d7eaf1dd4c0ab0bbe1
+branches:
+  only: master
+notifications: 
+  email: false

data/README.md

@@ -2,7 +2,7 @@ MetaHash
 ========
 
 [![Gem Version](https://badge.fury.io/rb/metahash-rb.svg)](http://badge.fury.io/rb/metahash-rb)
-[![](https://ci.solanolabs.com:443/TinderBox/MetaHash/badges/110842.png?badge_token=a5097ea0ff487d291e94285ed9e4c8fabeca5fd1)](https://ci.solanolabs.com:443/TinderBox/MetaHash/suites/110842)
+[![Build Status](https://travis-ci.org/NullVoxPopuli/MetaHash.svg)](https://travis-ci.org/NullVoxPopuli/MetaHash)
 [![Code Climate](https://codeclimate.com/github/NullVoxPopuli/MetaHash/badges/gpa.svg)](https://codeclimate.com/github/NullVoxPopuli/MetaHash)
 [![Dependency Status](https://gemnasium.com/NullVoxPopuli/MetaHash.svg)](https://gemnasium.com/NullVoxPopuli/MetaHash)
 [![Test Coverage](https://codeclimate.com/github/NullVoxPopuli/MetaHash/badges/coverage.svg)](https://codeclimate.com/github/NullVoxPopuli/MetaHash)
@@ -14,18 +14,45 @@ Provides a subclass of Hash and a wrapper around Rails' serialize attribute for
 ##  Examples
 #### Access nested hashes using method / object syntax
 
+Arand new Metadata objects act just like hashes:
+
     h = Metadata.new
-    h # => {}
-    h.outer.inner # => {}
+    h 
+    => {}
+    
+Accessing nested data requires no wrapping conditions checking for existence of the rquested data:
+
+    h.outer.inner
+    => {}
+
+Possible real-word example:
+
+    if (min_numbers = h.password_rules.formats.numbers.minimum).present?
+      # some code using min_numbers
+    else 
+      # data doesn't exist in h
+      
+      h.password_rules.formats.numbers.minimum = 1
+      # h 
+      # => { password_rules: { formats: { numbers: { minimum: 1 } } } }
+    end
 
 #### Access to values stored in nested hashes via method call syntax
 
     h = Metadata.new( { outer: { inner: { hash_key: "value" } } } )
-    h.outer.inner.hash_key # => "value"
+    
+    h.outer.inner.hash_key
+    => "value"
 
 #### Set values for nested hash structures without the nested hashes having to be initially defined
 
-    h = Metadata.new( {} )
+    h = Metadata.new
+    h
+    => {}
+    
+    h.outer.inner = 2
+    h
+    => { outer: { inner: 2 } }
 
 ## Using with ActiveRecord
 
@@ -54,3 +81,5 @@ This gem has been tested with Ruby 2.0, and rails 3.2, 4.1
 3. Add Test(s)!
 4. Commit your proposed changes
 5. Submit a pull request
+
+[![Analytics](https://ga-beacon.appspot.com/UA-54618821-1/your-repo/page-name)](https://github.com/igrigorik/ga-beacon)

data/lib/metahash.rb

@@ -1,5 +1,6 @@
 require "metahash/metaclass"
 require "metahash/metadata"
+require "metahash/extensions/hash/to_metadata"
 require "metahash/version"
 require 'active_record'
 
@@ -10,7 +11,7 @@ module MetaHash
   # the hash by creating class Metadata < Hash; end
   #
   # @param [Symbol] serialized_field name of the field to convert to Metadata
-  def has_metadata(serialized_field = "metadata", serializer: JSON)
+  def has_metadata( serialized_field = "metadata", serializer: JSON )
     # tell Active Record that the field is going to be JSON
     # serialized, because JSON > YAML
     serialize serialized_field, serializer
@@ -19,33 +20,39 @@ module MetaHash
       # first check the type of the field
       # proceed if hash, abort if Metadata
       if record.has_attribute?(serialized_field)
-        if [Hash, NilClass].include?(record.send(serialized_field).class)
+        if [ Hash, NilClass ].include?( record.send( serialized_field ).class )
           # alias the old method / field
           backup_name = "#{serialized_field}_original".to_sym
+
           # alias_method backup_name, serialized_field
-          record.define_singleton_method backup_name, record.method(serialized_field)
+          record.define_singleton_method( backup_name, record.method( serialized_field ) )
+
           # name the metadata accessor the same as the original field
           # rails should automatically serialize this on save
-          initial_value = record.send(backup_name) || {}
-          record.send("#{serialized_field}=", Metadata.new(initial_value))
+          initial_value = record.send( backup_name) || {}
+          record.send( "#{serialized_field}=", Metadata.new( initial_value ) )
         end
       end
     end
 
+    build_save_hooks( serialized_field )
+  end
 
+  private
+
+  def build_save_hooks( serialized_field )
     # create a before_save hook to store a pure Hash in the DB
     before_save do |record|
-      @temp_metadata = record.send(serialized_field)
-      record.send("#{serialized_field}=", @temp_metadata.to_hash) if @temp_metadata
+      @temp_metadata = record.send( serialized_field )
+      record.send( "#{serialized_field}=", @temp_metadata.to_hash ) if @temp_metadata
     end
 
     # restore the metadata to the field
     after_save do |record|
-      record.send("#{serialized_field}=", @temp_metadata) if @temp_metadata
+      record.send( "#{serialized_field}=", @temp_metadata ) if @temp_metadata
     end
-
   end
 
 end
 
-ActiveRecord::Base.send :extend, MetaHash
+ActiveRecord::Base.send( :extend, MetaHash )

data/lib/metahash/extensions/hash/to_metadata.rb

@@ -0,0 +1,9 @@
+class Hash
+  # Returns a copy of self represented as a Metahash
+  #
+  # m = { a: 1 }.to_metadata
+  # m.a # => 1
+  def to_metadata
+    Metadata.new(self)
+  end
+end

data/lib/metahash/metaclass.rb

@@ -4,16 +4,28 @@
 # particular class
 module Metaclass
   # The hidden singleton lurks behind everyone
-  def metaclass; class << self; self; end; end
-  def meta_eval &blk; metaclass.instance_eval &blk; end
+  def metaclass
+    class << self
+      self
+    end
+  end
+
+  def meta_eval(&block)
+    metaclass.instance_eval(&block)
+  end
 
   # Adds methods to a metaclass
-  def meta_def( name, &blk )
-    meta_eval { define_method name, &blk }
+  def meta_def(name, &block)
+    meta_eval {
+      define_method(name, &block)
+    }
   end
 
+  # unused
   # Defines an instance method within a class
-  def class_def( name, &blk )
-    class_eval { define_method name, &blk }
-  end
+  # def class_def(name, &block)
+  #   class_eval {
+  #     define_method(name, &block)
+  #   }
+  # end
 end

data/lib/metahash/metadata.rb

@@ -44,7 +44,7 @@ class Metadata < Hash
       # recursively create nested metadata objects
       hash.each do |key, value|
 
-        self[key] = (
+        self[ key ] = (
           if value.is_a?(Hash)
             Metadata.new(value)
           elsif value.is_a?(Array)
@@ -70,20 +70,7 @@ class Metadata < Hash
     if (key = method_name.to_s).include?("=")
       key = key.chop.to_sym
 
-      deepest_metadata = self
-      if not @empty_nested_hashes.empty?
-        @empty_nested_hashes.each do |key|
-          deepest_metadata = deepest_metadata[key] = Metadata.new
-        end
-        @empty_nested_hashes = []
-        deepest_metadata[key] = args[0]
-        # override any existing method with the key
-        deepest_metadata.meta_def(key){ self[key]}
-      else
-        self[key] = args[0]
-        # override any existing method with the key
-        self.meta_def(key){ args[0] }
-      end
+      assign_value(key, args[0])
     else
       value = self[method_name]
       if not value
@@ -134,4 +121,27 @@ class Metadata < Hash
   def to_ary
     self.to_hash.to_a
   end
+
+  alias_method :to_a, :to_ary
+
+  private
+
+  def assign_value(key, value)
+    deepest_metadata = self
+
+    if not @empty_nested_hashes.empty?
+      @empty_nested_hashes.each do |key|
+        deepest_metadata = deepest_metadata[key] = Metadata.new
+      end
+
+      @empty_nested_hashes = []
+      deepest_metadata[key] = value
+      # override any existing method with the key
+      deepest_metadata.meta_def(key){ self[key] }
+    else
+      self[key] = value
+      # override any existing method with the key
+      self.meta_def(key){ value }
+    end
+  end
 end

data/lib/metahash/version.rb

@@ -1,3 +1,3 @@
 module MetaHash
-  VERSION = "1.0.4"
+  VERSION = "1.1.0"
 end

data/spec/hash_spec.rb

@@ -0,0 +1,9 @@
+require "spec_helper"
+
+describe Hash do
+  context "to_metadata" do
+    subject(:h){ { a: 1 }.to_metadata }
+
+    it { is_expected.to be_a Metadata }
+  end
+end

data/spec/metadata_spec.rb

@@ -6,6 +6,95 @@ describe Metadata do
     expect(Metadata.new).to be_kind_of(Hash)
   end
 
+  context 'instance methods' do
+    let(:m){ Metadata.new(h) }
+
+    describe "[]" do
+      let(:key){h.keys.first}
+
+      it "retrieves with a string key" do
+        expect(m[key.to_s]).to eq h[key]
+      end
+
+      it "retrieves with a symbol key" do
+        expect(m[key.to_sym]).to eq h[key]
+      end
+    end
+
+    describe "[]=" do
+
+      it 'sets with a string key' do
+        m["a"] = 2
+        expect(m[:a]).to eq 2
+      end
+
+      it 'sets with a symbol key' do
+        m[:b] = 2
+        expect(m["b"]).to eq 2
+      end
+
+    end
+
+    describe "valid_key?" do
+
+      it "is true for keys that aren't methods" do
+        expect(m.valid_key?(:b)).to eq true
+      end
+
+      it "is false for existing methods" do
+        expect(m.valid_key?(:to_hash)).to eq false
+      end
+    end
+
+    describe "to_hash" do
+
+      it "converts to a hash" do
+        expect(m.to_hash).to_not be_kind_of Metadata
+      end
+
+      it "converts arrays" do
+        h = hash_with_array
+        m = Metadata.new(h)
+        expect(m.to_hash).to_not respond_to :array
+        expect(m.to_hash[:array]).to be_a Array
+      end
+
+    end
+
+    describe "to_ary or to_a" do
+
+      it "converts the hash to an array" do
+        expect(m.to_a).to eq m.to_hash.to_a
+      end
+
+    end
+
+    describe "initialize" do
+
+      it "copies hash contents" do
+        expect(Metadata.new(h)).to eq h
+      end
+
+      it "returns the argument" do
+        m = Metadata.new
+        expect(Metadata.new(m)).to eq m
+      end
+
+      it "creates metadata objects in an array" do
+        h = hash_with_array
+        m = Metadata.new(h)
+
+        expect(m.array.first.a).to eq 2
+        expect(m.array.last.b).to eq 3
+      end
+
+      it "raises an error with invalid input" do
+        expect{Metadata.new(2)}.to raise_error
+      end
+    end
+
+  end
+
   describe "pruning empty hashes" do
     let(:m){Metadata.new}
 
@@ -56,6 +145,13 @@ describe Metadata do
       expect(m.a.keys).to eq 3
     end
 
+    it "can overrid min and max of deeply nested hashes" do
+      m.password_rules.formats.digits.max = 3
+      m.password_rules.formats.digits.min = 2
+
+      expect(m.password_rules.formats.digits.min).to eq 2
+      expect(m.password_rules.formats.digits.max).to eq 3
+    end
   end
 
 

data/spec/spec_helper.rb

@@ -1,11 +1,18 @@
 
 require "rubygems"
 require "bundler/setup"
-require "metahash"
+
 require "pry-byebug" # binding.pry to debug!
+
+# Coverage
 require "codeclimate-test-reporter"
+ENV['CODECLIMATE_REPO_TOKEN'] = "1d1b1a31bb3137d986297ad8a1ad5a3a1adbd70f0e8583d7eaf1dd4c0ab0bbe1"
 CodeClimate::TestReporter.start
 
+# This Gem
+require "metahash"
+
+
 ActiveRecord::Base.establish_connection adapter: "sqlite3", database: ":memory:"
 load File.dirname(__FILE__) + '/support/schema.rb'
 Dir[File.dirname(__FILE__) + '/support/**/*.rb'].each {|file| require file }

data/spec/support/sample_hashes.rb

@@ -7,3 +7,12 @@ def h
     }
   }
 end
+
+def hash_with_array
+  {
+    array: [
+      { a: 2 },
+      { b: 3 }
+    ]
+  }
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metahash-rb
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.1.0
 platform: ruby
 authors:
 - L. Preston Sego III
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-09 00:00:00.000000000 Z
+date: 2014-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -103,22 +103,24 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - lib/metahash.rb
+- lib/metahash/extensions/hash/to_metadata.rb
 - lib/metahash/metaclass.rb
 - lib/metahash/metadata.rb
 - lib/metahash/version.rb
 - metahash.gemspec
+- spec/hash_spec.rb
 - spec/metadata_spec.rb
 - spec/metahash_spec.rb
 - spec/spec_helper.rb
 - spec/support/models/test_object.rb
 - spec/support/sample_hashes.rb
 - spec/support/schema.rb
-- tddium.yml
 homepage: https://github.com/NullVoxPopuli/MetaHash
 licenses:
 - MIT
@@ -142,8 +144,9 @@ rubyforge_project:
 rubygems_version: 2.4.1
 signing_key: 
 specification_version: 4
-summary: MetaHash-1.0.4
+summary: MetaHash-1.1.0
 test_files:
+- spec/hash_spec.rb
 - spec/metadata_spec.rb
 - spec/metahash_spec.rb
 - spec/spec_helper.rb

data/tddium.yml

@@ -1,3 +0,0 @@
-:tddium:
-  :ruby_version: ruby-2.1.2
-  :coverage: true