hash_gleaner 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 793b3cd699bd9aaf6752dbf535fbafebe06d8271
+  data.tar.gz: b65f1d6ad827696689dee4a8340bb18b59e402c3
+SHA512:
+  metadata.gz: 8f531a2c6f8f5ed0989fd59482cf82f824dacb69805ff72fdab81e56405c18c59e939200ce7866c151340620465ab977727585c5b957f451caf8113f59f7de68
+  data.tar.gz: 7a1e93023da03433a8488b69a23c99c3f234369656596c067055d2d14209f2eafbfaddf30b8b24c9e9d349898d7a9d12b19976c3b2271952786cec2d95bfd0c7

data/Gemfile

@@ -0,0 +1,2 @@
+source "http://rubygems.org"
+gemspec

data/Gemfile.lock

@@ -0,0 +1,28 @@
+PATH
+  remote: .
+  specs:
+    hash_gleaner (0.1.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    rspec (3.0.0)
+      rspec-core (~> 3.0.0)
+      rspec-expectations (~> 3.0.0)
+      rspec-mocks (~> 3.0.0)
+    rspec-core (3.0.2)
+      rspec-support (~> 3.0.0)
+    rspec-expectations (3.0.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.0.0)
+    rspec-mocks (3.0.2)
+      rspec-support (~> 3.0.0)
+    rspec-support (3.0.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  hash_gleaner!
+  rspec

data/README.md

@@ -0,0 +1,96 @@
+# HashGleaner
+## Summary
+`HashGleaner` allows you to declare hash structure you want to get like Strong Parameters.
+
+## Example
+
+```ruby
+require 'hash_gleaner'
+
+h = {
+  :account => {
+    :id => 1234,
+    :email => 'xxx@xxx.xx',
+    :name => 'John Doe',
+    :phone => [
+      {
+        :id => 2345,
+        :type => 'mobile',
+        :number => 'xxxxxxxxxx',
+      },
+      {
+        :id => 2346,
+        :type => 'office',
+        :number => 'yyyyyyyyyy',
+      },
+    ],
+  },
+}
+
+params = HashGleaner.apply(h) do
+           o :account do
+             o :name
+             o :phone do
+               o :type
+               o :number
+             end
+           end
+         end
+#=> {:account=>{:name=>"John Doe", :phone=>[{:type=>"mobile", :number=>"xxxxxxxxxx"}, {:type=>"office", :number=>"yyyyyyyyyy"}]}}
+```
+
+When `Hash` object includes `HashGleaner` module, you can use `glean` method.
+
+```ruby
+class << h; include HashGleaner; end
+
+params = h.glean do
+           o :account do
+             o :name
+             o :phone do
+               o :type
+               o :number
+             end
+           end
+         end
+```
+
+hash structure can be described as `Proc` object.
+
+```ruby
+proc = Proc.new{
+  o :account do
+    o :name
+    o :phone do
+      o :type
+      o :number
+    end
+  end
+}
+
+params = h.glean(proc)
+params = HashGleaner.apply(h, proc)
+```
+
+You can describe `required` or `optional` in hash structure.
+When the hash object misses any required keys,
+`HashGleaner` raises `MissingKeysException`.
+
+```ruby
+proc = Proc.new{
+  (required)
+  o :account do
+    o :name
+    o :phone do
+      (required)
+      o :number
+      o :name
+    end
+  end
+  (optional)
+  o :admin
+}
+
+params = h.glean(proc)
+#=> HashGleaner::MissingKeyException: Missing required keys [:name]
+```

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler"
+Bundler::GemHelper.install_tasks
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new
+
+task default: :spec

data/hash_gleaner.gemspec

@@ -0,0 +1,19 @@
+# -*- coding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name          = "hash_gleaner"
+  s.authors       = ["hosim"]
+  s.email         = ["github.hosim@gmail.com"]
+  s.description   = "HashGleaner allows you to declare hash structure you want to get."
+  s.summary       = "HashGleaner allows you to declare hash structure you want to get."
+  s.homepage      = "https://github.com/hosim/hash_gleaner"
+  s.executables   = `git ls-files -- bin/*`.split("\n").map {|f| File.basename(f) }
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_paths = ["lib"]
+  s.version       = "0.1.0"
+  s.license       = "MIT"
+
+  s.add_development_dependency 'rspec'
+end

data/lib/hash_gleaner.rb

@@ -0,0 +1,32 @@
+# coding: utf-8
+require 'hash_gleaner/list'
+require 'hash_gleaner/missing_keys'
+
+module HashGleaner
+  class << self
+    def included(base)
+      base.__send__ :include, InstanceMethods
+    end
+
+    def apply(hash, proc=nil, &block)
+      missing_keys = MissingKeys.new
+      action = (block if block_given?) || (proc if proc.is_a? Proc)
+      h = List.new(hash, missing_keys).instance_eval(&action) if action
+      raise MissingKeysException.new(missing_keys) if missing_keys.has_keys?
+      h
+    end
+  end
+
+  module InstanceMethods
+    def glean(proc=nil, &block)
+      HashGleaner.apply(self, proc, &block)
+    end
+  end
+
+  class MissingKeysException < StandardError
+    def initialize(missing_keys)
+      msg = "Missing required keys #{missing_keys.keys.uniq}"
+      super(msg)
+    end
+  end
+end

data/lib/hash_gleaner/list.rb

@@ -0,0 +1,35 @@
+# coding: utf-8
+require 'hash_gleaner/value_gleaner'
+require 'hash_gleaner/missing_keys'
+
+module HashGleaner
+  class List
+    def initialize(hash, missing_keys)
+      @origin = hash
+      @hash = {}
+      @mode = :optional
+      @missing_keys = missing_keys
+      @gleaner = ValueGleaner.new(missing_keys)
+    end
+
+    def o(name, *options, &block)
+      unless @origin.has_key?(name)
+        @missing_keys.add(name) if @mode == :required
+        return @hash
+      end
+
+      @hash[name] = @gleaner.glean(@origin[name], block, {})
+      @hash
+    end
+
+    def required
+      @mode = :required
+      @hash
+    end
+
+    def optional
+      @mode = :optional
+      @hash
+    end
+  end
+end

data/lib/hash_gleaner/missing_keys.rb

@@ -0,0 +1,23 @@
+# coding: utf-8
+
+module HashGleaner
+  class MissingKeys
+    def initialize
+      @keys = []
+    end
+
+    def add(key)
+      keys << key
+    end
+
+    def has_keys?
+      ! keys.empty?
+    end
+
+    def clear
+      @keys = []
+    end
+
+    attr_reader :keys
+  end
+end

data/lib/hash_gleaner/value_gleaner.rb

@@ -0,0 +1,31 @@
+# coding: utf-8
+
+module HashGleaner
+  class ValueGleaner
+    def initialize(missing_keys)
+      @missing_keys = missing_keys
+    end
+
+    def value_type(value)
+      return :array if value.is_a? Array
+      return :hash  if value.is_a? Enumerable
+      return :single
+    end
+
+    def glean(value, proc, empty_hash=Empty)
+      case value_type(value)
+      when :single
+        value
+      when :hash
+        proc ? List.new(value, @missing_keys).instance_eval(&proc) : empty_hash
+      when :array
+        value.each_with_object([]) {|val, a|
+          v = glean(val, proc)
+          a << v unless v == Empty
+        }
+      end
+    end
+  end
+
+  class Empty; end
+end

data/spec/hash_gleaner/list_spec.rb

@@ -0,0 +1,282 @@
+# -*- encoding: utf-8 -*-
+require 'spec_helper'
+
+describe HashGleaner::List do
+  let(:missing_keys) { HashGleaner::MissingKeys.new }
+
+  describe '#o' do
+    context 'when an original Hash has the specified key' do
+      let(:original_hash) do
+        {
+          foo: :zzz,
+          baa: [:wibble, :wobble, :wubble],
+          baz: {
+            spam: :pee,
+            ham: :kaa,
+            egg: :boo,
+          },
+          qux: [
+            {
+              toto: :hoge,
+              titi: :fuga,
+              tutu: :piyo,
+            },
+            {
+              toto: :bla,
+              titi: :bla,
+              tutu: :bla,
+            },
+          ],
+          xyzzy: [
+            [:a, :b, :c],
+            {
+              spam: :_,
+              ham:  :_,
+              egg:  :_,
+            },
+            {
+              hoge: {
+                foo: [:wibble],
+              },
+              fuge: {
+                foo: :a,
+              },
+              piyo: [
+                {
+                  abc: :x,
+                  def: :y,
+                  ghi: :z,
+                },
+              ],
+            },
+          ],
+        }
+      end
+
+      let(:gleaner) do
+        described_class.new(original_hash, missing_keys)
+      end
+
+      context 'and the value is not a Hash nor an Array' do
+        subject { gleaner.o :foo }
+
+        it "returns a Hash that contains the key and the value" do
+          expect(subject).to have_key(:foo)
+          expect(subject[:foo]).to be :zzz
+        end
+      end
+
+      context 'and the value is a Hash' do
+        context 'and passed no block' do
+          subject { gleaner.o :baz }
+
+          it "returns a Hash that contains the key and " \
+             "a blank Hash as its value" do
+            expect(subject).to have_key(:baz)
+
+            value = subject[:baz]
+            expect(value).to be_an_instance_of(Hash)
+            expect(value).to be_empty
+          end
+        end
+
+        context 'and passed a block' do
+          subject {
+            gleaner.o :baz do
+              o :ham
+              o :egg
+            end
+          }
+
+          it "returns a Hash that contains the key and " \
+             "a hash that has pairs the block defined" do
+            expect(subject).to have_key(:baz)
+
+            value = subject[:baz]
+            expect(value).to be_an_instance_of(Hash)
+            expect(value.keys).to match_array([:ham, :egg])
+            expect(value[:ham]).to be :kaa
+            expect(value[:egg]).to be :boo
+          end
+        end
+      end
+
+      context 'and the value is an Array of scalas' do
+        subject { gleaner.o :baa }
+
+        it "returns a Hash that contains the key and the array" do
+          expect(subject).to have_key(:baa)
+
+          value = subject[:baa]
+          expect(value).to be_an_instance_of(Array)
+          expect(value.size).to be 3
+          expect(value[0]).to be :wibble
+          expect(value[1]).to be :wobble
+          expect(value[2]).to be :wubble
+        end
+      end
+
+      context 'and the value is an Array of Hashs' do
+        context 'and no block is passed' do
+          subject { gleaner.o :qux }
+
+          it "returns a Hash that contains the key and a blank Array as its value" do
+            expect(subject).to have_key(:qux)
+
+            value = subject[:qux]
+            expect(value).to be_an_instance_of(Array)
+            expect(value).to be_empty
+          end
+        end
+
+        context 'and a block is passed' do
+          subject {
+            gleaner.o :qux do
+              o :toto
+              o :tutu
+            end
+          }
+
+          it "returns a Hash that contains the key and an Array of Hashs " \
+             "that has the pairs of a key and a value that is defined the block" do
+            expect(subject).to have_key(:qux)
+
+            value = subject[:qux]
+            expect(value).to be_an_instance_of(Array)
+            expect(value[0]).to be_an_instance_of(Hash)
+            expect(value[0].keys).to match_array([:toto, :tutu])
+            expect(value[0][:toto]).to be :hoge
+            expect(value[0][:tutu]).to be :piyo
+            expect(value[1]).to be_an_instance_of(Hash)
+            expect(value[1].keys).to match_array([:toto, :tutu])
+            expect(value[1][:toto]).to be :bla
+            expect(value[1][:tutu]).to be :bla
+          end
+        end
+      end
+
+      context 'and the value is an Array of mixed types' do
+        context 'and no block is passed' do
+          subject { gleaner.o :xyzzy }
+
+          it "returns a Hash that contains the key and an Array that " \
+             "contains values except for Hashs as its value" do
+            expect(subject).to have_key(:xyzzy)
+
+            value = subject[:xyzzy]
+            expect(value).to be_an_instance_of(Array)
+            expect(value.size).to be 1
+            expect(value.first).to be_an_instance_of(Array)
+            expect(value.first.size).to be 3
+            expect(value.first[0]).to be :a
+            expect(value.first[1]).to be :b
+            expect(value.first[2]).to be :c
+          end
+        end
+
+        context 'and a block is passed' do
+          subject {
+            gleaner.o :xyzzy do
+              o :spam
+              o :hoge do
+                o :foo
+              end
+              o :fuge
+              o :piyo do
+                o :def
+              end
+            end
+          }
+
+          it "returns a Hash that contains the specified key" do
+            expect(subject).to be_an_instance_of(Hash)
+            expect(subject).to have_key(:xyzzy)
+          end
+
+          describe "its value" do
+            it "is an Array as the associated value" do
+              value = subject[:xyzzy]
+              expect(value).to be_an_instance_of(Array)
+              expect(value).not_to be_empty
+            end
+
+            it "has an Array if that is defined in a block" do
+              value = subject[:xyzzy].first
+              expect(value).to be_an_instance_of(Array)
+              expect(value.size).to be 3
+              expect(value[0]).to be :a
+              expect(value[1]).to be :b
+              expect(value[2]).to be :c
+            end
+
+            it "has a Hash if that is defined in a block" do
+              value = subject[:xyzzy][1]
+              expect(value).to be_an_instance_of(Hash)
+              expect(value.keys).to match_array([:spam])
+              expect(value[:spam]).to be :_
+
+              value = subject[:xyzzy][2]
+              expect(value).to be_an_instance_of(Hash)
+              expect(value.keys).to match_array([:hoge, :fuge, :piyo])
+              expect(value[:hoge]).to be_an_instance_of(Hash)
+              expect(value[:hoge].keys).to match_array([:foo])
+              expect(value[:hoge][:foo]).to be_an_instance_of(Array)
+              expect(value[:hoge][:foo]).to eq [:wibble]
+
+              expect(value[:fuge]).to be_an_instance_of(Hash)
+              expect(value[:fuge]).to be_empty
+
+              expect(value[:piyo]).to be_an_instance_of(Array)
+              expect(value[:piyo].size).to be 1
+              expect(value[:piyo].first).to be_an_instance_of(Hash)
+              expect(value[:piyo].first.keys).to match_array([:def])
+            end
+          end
+        end
+      end
+    end
+
+    context 'when an original Hash does not have the specified key' do
+      let(:original_hash) do
+        {
+          pee: :foo,
+          kaa: :baa,
+          boo: :baz,
+        }
+      end
+
+      let(:gleaner) do
+        described_class.new(original_hash, missing_keys)
+      end
+
+      context 'and it is in default mode' do
+        subject { gleaner.o :foo }
+
+        it "returns a blank Hash" do
+          expect(subject).to be_an_instance_of(Hash)
+          expect(subject).to be_empty
+        end
+      end
+
+      context 'and it is in required mode' do
+        before { gleaner.required }
+
+        it "adds MissingKeys" do
+          expect(missing_keys.keys).to be_empty
+          gleaner.o :foo
+          expect(missing_keys.keys).to match_array([:foo])
+        end
+      end
+
+      context 'and it is in optional mode' do
+        before { gleaner.optional }
+        subject { gleaner.o :foo }
+
+        it "returns a blank Hash" do
+          expect(subject).to be_an_instance_of(Hash)
+          expect(subject).to be_empty
+        end
+      end
+    end
+  end
+end

data/spec/hash_gleaner_spec.rb

@@ -0,0 +1,20 @@
+# -*- coding: utf-8 -*-
+require "spec_helper"
+
+describe HashGleaner do
+  describe ".included" do
+    let(:clazz) {
+      clazz = Class.new(Hash)
+      clazz.__send__ :include, HashGleaner
+      clazz
+    }
+
+    let(:instance) {
+      clazz.new
+    }
+
+    it "responds to glean method" do
+      expect(instance).to respond_to(:glean)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+# -*- coding: utf-8 -*-
+
+require 'rspec'
+require 'hash_gleaner'
+
+Dir.glob("#{File.dirname(__FILE__)}/support/**/*.rb") do |f|
+  require f
+end
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: hash_gleaner
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- hosim
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: HashGleaner allows you to declare hash structure you want to get.
+email:
+- github.hosim@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- hash_gleaner.gemspec
+- lib/hash_gleaner.rb
+- lib/hash_gleaner/list.rb
+- lib/hash_gleaner/missing_keys.rb
+- lib/hash_gleaner/value_gleaner.rb
+- spec/hash_gleaner/list_spec.rb
+- spec/hash_gleaner_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/hosim/hash_gleaner
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: HashGleaner allows you to declare hash structure you want to get.
+test_files:
+- spec/hash_gleaner/list_spec.rb
+- spec/hash_gleaner_spec.rb
+- spec/spec_helper.rb