lab42_nhash 0.1.0.pre

data/lib/lab42/nhash/affixes.rb

@@ -0,0 +1,48 @@
+require_relative './exceptions'
+module Lab42
+  class NHash
+    module Afixes
+
+      def pop_prefix; @prefix_stack.pop; self end
+      def pop_suffix; @suffix_stack.pop; self end
+      def push_prefix pfx; @prefix_stack.push pfx.to_s; self end
+      def push_suffix sfx; @suffix_stack.push sfx.to_s; self end
+
+      def current_prefix
+        @prefix_stack
+        .fetch( -1, '' )
+        .split( '.' )
+      end
+
+      def current_suffix
+        @suffix_stack
+        .fetch( -1, '' )
+        .split( '.' )
+      end
+
+      def with_affixes pfx, sfx, &blk
+        push_prefix pfx
+        push_suffix sfx
+        _invoke blk, self
+      ensure
+        pop_prefix
+        pop_suffix
+      end
+
+      def with_prefix pfx, &blk
+        push_prefix pfx
+        _invoke blk, self
+      ensure
+        pop_prefix
+      end
+
+      def with_suffix sfx, &blk
+        push_suffix sfx
+        _invoke blk, self
+      ensure
+        pop_suffix
+      end
+    end # module Afixes
+    include Afixes
+  end # class NHash
+end # module Lab42

data/lib/lab42/nhash/auto_import.rb

@@ -0,0 +1,3 @@
+require_relative '../nhash'
+
+NHash = Lab42::NHash

data/lib/lab42/nhash/exceptions.rb

@@ -0,0 +1,5 @@
+module Lab42
+  class NHash
+    IllegalStateError = Class.new RuntimeError 
+  end # class NHash
+end # module Lab42

data/lib/lab42/nhash/fallbacks.rb

@@ -0,0 +1,70 @@
+module Lab42
+  class NHash
+    module Fallbacks
+      def again
+        raise IllegalStateError, "must not call again before a failed get/fetch" unless @inside_fallback
+        get( *@fallback_params )
+      end
+
+      def clear_fallbacks!
+        @fallbacks = []
+      end
+
+      def pop_fallback
+        raise IllegalStateError, "must not tamper with the fallback stack inside fallbacks" if @inside_fallback
+
+        @fallbacks.pop
+
+        self
+      end
+
+      def push_fallback fb=nil, &blk
+        raise ArgumentError, "need to provide a lambda or a block" unless fb || blk
+        assure_not_inside_fallback
+        
+        @current_fallback_pointer = @fallbacks.size
+        @fallbacks.push( fb || blk )
+
+        self
+      end
+
+      def with_fallback b=nil, &blk
+        assure_not_inside_fallback
+        save_fallback_pointer = @current_fallback_pointer
+        _invoke (b||blk), self
+      ensure
+        @current_fallback_pointer = save_fallback_pointer
+      end
+
+      private
+      def assure_not_inside_fallback
+        raise IllegalStateError, "must not tamper with the fallback stack inside fallbacks" if @inside_fallback
+      end
+      def current_fallback
+        @fallbacks[ @current_fallback_pointer ]
+      end
+      # Contract: Invoked only after a KeyError raising get/fetch
+      def fallback keyexpr, k
+        raise k unless current_fallback
+        @inside_fallback = true # according to contract, setting the flag allowing the invocation of again
+        @fallback_params = keyexpr
+        invoke_current_fallback
+      ensure
+        @inside_fallback = false # forbid @again invocation again (pun intended)
+      end
+
+      def invoke_current_fallback
+        fb = current_fallback
+        @current_fallback_pointer -= 1
+        @current_fallback_pointer = @fallbacks.size if @current_fallback_pointer < 0
+        _invoke( fb, self ).tap do
+          # Make sure to reset if nothing was raised inside the invocation
+          @current_fallback_pointer = @fallbacks.size - 1
+        end
+      end
+
+    end # module Fallbacks
+
+    include Fallbacks
+  end # class NHash
+end # module Lab42

data/lib/lab42/nhash/interpolation.rb

@@ -0,0 +1,21 @@
+require 'erb'
+
+module Lab42
+  class NHash
+    module Interpolation
+      def get! *args, &blk
+        result = get( *args, &blk )
+        return result unless String === result
+        _expand_result result
+      end
+      alias_method :fetch!, :get!
+
+      private
+      def _expand_result result
+        ERB.new( result ).result( binding )
+      end
+      
+    end # module Interpolation
+    include Interpolation
+  end # class NHash
+end # module Lab42

data/lib/lab42/nhash/invocation.rb

@@ -0,0 +1,16 @@
+module Lab42
+  class NHash
+    module Invocation
+      private
+      def _invoke a_proc, *args
+        if a_proc.arity < 0 || a_proc.arity == args.size
+          a_proc.( *args )
+        else
+          args.first.instance_exec(&a_proc)
+        end
+      end
+    end # module Invocation
+
+    include Invocation
+  end # class NHash
+end # module Lab42

data/lib/lab42/nhash/lookup_chains.rb

@@ -0,0 +1,50 @@
+module Lab42
+  class NHash
+    module LookupChains
+      def push_prefix_lookup *prefixes
+        prefixes.reverse.each do | prefix |
+          push_fallback do
+            with_prefix prefix do
+              again
+            end
+          end
+        end
+      end
+      
+      def push_suffix_lookup *suffixes
+        suffixes.reverse.each do | suffix |
+          push_fallback do
+            with_suffix suffix do
+              again
+            end
+          end
+        end
+      end
+
+      def push_affix_lookup( prefixes: required, suffixes: required, suffixes_first: false )
+        if suffixes_first
+          suffixes.product( prefixes ).reverse.each do | suff, pref |
+            push_fallback do
+              with_suffix suff do
+                with_prefix pref do
+                  again
+                end
+              end
+            end
+          end
+        else
+          prefixes.product( suffixes ).reverse.each do | pref, suff |
+            push_fallback do
+              with_suffix suff do
+                with_prefix pref do
+                  again
+                end
+              end
+            end
+          end
+        end
+      end
+    end # module LookupChains
+    include LookupChains
+  end # class NHash
+end # module Lab42

data/lib/lab42/nhash/version.rb

@@ -0,0 +1,5 @@
+module Lab42
+  class NHash
+    VERSION = '0.1.0.pre'
+  end # class NHash
+end # module Lab42

data/lib/lab42/nhash.rb

@@ -0,0 +1,76 @@
+require_relative './nhash/exceptions'
+require_relative './nhash/invocation'
+require_relative './nhash/affixes'
+require_relative './nhash/fallbacks'
+require_relative './nhash/lookup_chains'
+require_relative './nhash/interpolation'
+
+module Lab42
+  class NHash
+
+    attr_reader :hashy
+
+    def get keyexpr, *default, &defblock
+      keys = keyexpr.to_s.split( '.' )
+      keys = complete_keys keys.reject(&:empty?), use_prefix: keys.first.empty?, use_suffix: keyexpr[-1] == '.'
+      found = @indifferent_access ? _get_indiff( keys ) : _get( keys )
+      case found
+      when Hash
+        self.class.new( found ).import_options export_options
+      else
+        found
+      end
+    rescue KeyError => k
+      return fallback keyexpr, k if default.empty? && defblock.nil?
+      default.empty? ? defblock.(keyexpr) : default.first
+    end
+    alias_method :fetch, :get
+
+    def import_options options
+      @indifferent_access = options[:indifferent_access]
+      self
+    end
+
+    def with_indifferent_access
+      self.class.new( @hashy ).import_options indifferent_access: true
+    end
+
+    private
+    def complete_keys keys, use_prefix: false, use_suffix: false
+      keys =  current_prefix + keys if use_prefix
+      keys += current_suffix if use_suffix
+      keys
+    end
+
+    # TODO: This is inefficent, either cache it or split on pushing onto stack
+    def _get keys
+      keys.inject hashy do | partial_hash, key_element |
+        raise KeyError, keys.join('.') unless Hash === partial_hash
+        partial_hash.fetch key_element
+      end
+    end
+
+    def _get_indiff keys
+      keys.inject hashy do | partial_hash, key_element |
+        raise KeyError, keys.join('.') unless Hash === partial_hash
+        partial_hash.fetch( key_element ){ partial_hash.fetch key_element.to_sym }
+      end
+    end
+    def export_options
+      { indifferent_access: @indifferent_access }
+    end
+
+    def initialize hashy
+      @hashy = hashy
+      init_options
+    end
+
+    def init_options
+      @indifferent_access       = false
+      @suffix_stack             = []
+      @prefix_stack             = []
+      @fallbacks                = []
+      @current_fallback_pointer = 0
+    end
+  end # class NHash
+end # module Lab42

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require_relative "../lib/lab42/nhash/auto_import"
+
+PROJECT_ROOT = File.expand_path "../..", __FILE__
+Dir[File.join(PROJECT_ROOT,"spec/support/**/*.rb")].each {|f| require f}
+
+RSpec.configure do |c|
+  c.treat_symbols_as_metadata_keys_with_true_values = true
+  c.filter_run wip: true
+  c.run_all_when_everything_filtered = true
+end
+

data/spec/unit/afixes/affix_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe NHash do 
+  subject do
+    described_class.new( "a" => { 
+      "b" => 
+      { "c" => 'abc' } })
+  end
+
+  it "can access with affixes" do
+    expect( subject.with_affixes( 'a', 'c') do
+             get '.b.'
+           end
+          ).to eq( 'abc' )
+  end
+
+end # describe NHash

data/spec/unit/afixes/prefix_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe NHash do 
+  subject do
+    described_class.new({ "a" => { 
+      "b" => 
+      { "c" => 'abc',
+        "d" => 'abd' } },
+        "x" => {
+          "b" =>
+          { "c" => 'xbc' } } })
+      .push_prefix 'a.b' 
+  end
+
+  it "can access normally" do
+    expect( subject.get('a.b.c') ).to eq( 'abc' )
+  end
+
+  it "or with a prefix" do
+    expect( subject.get( '.c' ) ).to eq( 'abc' )
+  end
+end # describe NHash

data/spec/unit/afixes/suffix_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe NHash do 
+  subject do
+    described_class.new({ "a" => { 
+      "b" => 
+      { "c" => 'abc',
+        "d" => 'abd' } },
+        "x" => {
+          "b" =>
+          { "c" => 'xbc' } } })
+      .push_suffix 'b.c' 
+  end
+
+  it "can access normally" do
+    expect( subject.get('a.b.c') ).to eq( 'abc' )
+  end
+
+  it "or with a suffix" do
+    expect( subject.get( 'a.' ) ).to eq( 'abc' )
+    expect( subject.get( 'x.' ) ).to eq( 'xbc' )
+  end
+end # describe NHash

data/spec/unit/fallback/fallback_spec.rb

@@ -0,0 +1,91 @@
+require 'spec_helper'
+
+describe NHash do
+  subject do
+    NHash.new(
+      en: { '1' => 'one', '2' => 'two', '3' => 'three' },
+      fr: { '1' => 'un',  '2' => 'deux' },
+      it: { '1' => 'uno' } )
+    .with_indifferent_access
+  end
+
+  context 'non regression if no fallbacks are declared' do 
+    it 'accesses correctly' do
+      expect( subject.get('it.1' ) ).to eq 'uno'
+    end
+    it 'raises KeyError correctly' do
+      expect( 
+             ->{
+               subject.get 'it.2'
+             }
+            ).to raise_error KeyError
+    end
+
+  end # context 'non regression if no fallbacks are declared'
+
+  context :fallbacks do 
+    before do
+      subject.push_fallback do
+        # let us use English as the last ressort
+        with_prefix(:en){again}
+      end
+    end
+
+    context :one_level_fallback do 
+      it 'still works' do
+        subject.with_prefix( :it ) do | n |
+          expect( n.get( '.1' ) ).to eq 'uno'
+        end
+      end
+
+      it 'finds the english value else' do
+        subject.with_prefix( :it ) do | n |
+          expect( n.get( '.2' )).to eq 'two'
+        end
+      end
+
+      context :second_level_fallback do 
+        before do
+          subject.push_fallback do |s|
+            s.with_prefix(:fr){ 
+              again
+            }
+          end
+        end
+        it 'still works' do
+          subject.with_prefix( :it ) do | n |
+            expect( n.get( '.1' ) ).to eq 'uno'
+          end
+        end
+
+        it 'finds the french value if present' do
+          subject.with_prefix( :it ) do | n |
+            expect( n.get( '.2' )).to eq 'deux'
+          end
+        end
+
+        it 'otherwise finds the english value' do
+          subject.with_prefix( :it ) do | n |
+            expect( n.get( '.3' )).to eq 'three'
+          end
+        end
+      end # context :second_level_fallback
+
+      context :clear_fallbacks do 
+        before do
+          subject.clear_fallbacks!
+        end
+
+        it 'raises a KeyError now' do
+          subject.with_prefix( :it ) do | n |
+            expect( 
+                   ->{
+                     n.get( '.2' )
+                   }
+                  ).to raise_error KeyError
+          end
+        end
+      end # context :clear_fallbacks
+    end # context :normal_access
+  end # context :fallbacks
+end # describe NHash

metadata

@@ -0,0 +1,199 @@
+--- !ruby/object:Gem::Specification
+name: lab42_nhash
+version: !ruby/object:Gem::Version
+  version: 0.1.0.pre
+platform: ruby
+authors:
+- Robert Dober
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: forwarder2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: ruby_parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: pry-debugger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: ae
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: qed
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.9'
+description: A Nested Hash with dotted access à la I18n in Rails
+email:
+- robert.dober@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- demo/000-basic-examples.md
+- demo/010-indifferent-access.md
+- demo/020-afixes.md
+- demo/030-lookup-chains.md
+- demo/060-fallback.md
+- demo/080-interpolation.md
+- demo/applique/require_ae.rb
+- demo/applique/require_nhash.rb
+- lab42_nhash.gemspec
+- lib/lab42/nhash.rb
+- lib/lab42/nhash/affixes.rb
+- lib/lab42/nhash/auto_import.rb
+- lib/lab42/nhash/exceptions.rb
+- lib/lab42/nhash/fallbacks.rb
+- lib/lab42/nhash/interpolation.rb
+- lib/lab42/nhash/invocation.rb
+- lib/lab42/nhash/lookup_chains.rb
+- lib/lab42/nhash/version.rb
+- spec/spec_helper.rb
+- spec/unit/afixes/affix_spec.rb
+- spec/unit/afixes/prefix_spec.rb
+- spec/unit/afixes/suffix_spec.rb
+- spec/unit/fallback/fallback_spec.rb
+homepage: https://github.com/RobertDober/lab42_nested_hash
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 2.2.2
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A nested hash view with dotted deep access à la I18n.t of Rails and with
+  optional string interpolation. Typically YML loaded Hashes are used.
+test_files:
+- demo/000-basic-examples.md
+- demo/010-indifferent-access.md
+- demo/020-afixes.md
+- demo/030-lookup-chains.md
+- demo/060-fallback.md
+- demo/080-interpolation.md
+- demo/applique/require_ae.rb
+- demo/applique/require_nhash.rb
+- spec/spec_helper.rb
+- spec/unit/afixes/affix_spec.rb
+- spec/unit/afixes/prefix_spec.rb
+- spec/unit/afixes/suffix_spec.rb
+- spec/unit/fallback/fallback_spec.rb