tender_hash 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 332ad5b937b547b141b7815e24b5f81238b70e31
+  data.tar.gz: e77dd0545547f84ec6015f8e4223763346065fef
+SHA512:
+  metadata.gz: 6221fe934b6907466657b7caecead851c3b15b7261e4d6d5694170001357052e589df10589083f77e2fca7682403041121ba9cc83ba72a2931192ddb771f0529
+  data.tar.gz: 8cd09654f4e1007d1f038473fc991e18f856c38bac3d9d90158c1de01eecaf362b99955056708310b2606f525889bb10746c0a1f57e415f68d1b8dd08278d67a

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-gemset

@@ -0,0 +1 @@
+hash_mapper

data/.ruby-version

@@ -0,0 +1 @@
+2.1.1

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in tender_hash.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Rodrigo Pavano
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,124 @@
+# TenderHash
+
+Map hashes with style.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'tender_hash'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tender_hash
+
+## Usage
+
+An empty set of rules will filter all keys returning an empty hash.
+
+```ruby
+TenderHash.map( { name: 'Rodrigo', age: 27 } )
+```
+
+The `key` method will cause the mapper to keep the specified key without
+making any changes.
+
+```ruby
+TenderHash.map( { name: 'Rodrigo', age: 27 } ) do
+  key :name
+end
+
+# => { name: 'Rodrigo' }
+```
+
+The `map_key` methods allows to define mappings for the hash keys.
+
+```ruby
+TenderHash.map( { name: 'Rodrigo', age: 27 } ) do
+  map_key :name, :first_name
+end
+
+# => { first_name: 'Rodrigo' }
+```
+
+The `key` and `map_key` methods accept a `default` option. If the input hash
+doesn't have the key defined or if it's value is `nil`, then the default value
+will be set for that key on the returned hash.
+
+```ruby
+TenderHash.map( { name: 'Rodrigo', age: 27 } ) do
+  map_key :name, :first_name, default: 'John Doe'
+  key :height, default: 1.90
+end
+
+# => { first_name: 'Rodrigo', height: 1.90 }
+```
+
+The `key` and `map_key` methods also accept a `cast_to` option. The
+possible alternatives are: `:integer`, `:string` and `:boolean`.
+
+```ruby
+TenderHash.map( { name: 'Rodrigo', age: 27, logged_in: 'false' } ) do
+  key :age,       cast_to: :string
+  key :logged_in, cast_to: :boolean
+end
+
+# => { age: '27', looged_in: false }
+```
+
+The `scope` method allows to nest a hash within a key.
+
+```ruby
+TenderHash.map( { name: 'Rodrigo', age: 27, logged_in: 'false' } ) do
+  scope :personal_info do
+    map_key :name, :first_name
+    key :age
+  end
+
+  key :logged_in
+end
+
+# => {
+#       personal_info: {
+#         first_name: 'Rodrigo',
+#         age: 27
+#       },
+#       logged_in: 'false'
+#    }
+```
+
+A good use case for this gem is to map the `ENV` hash into a more
+readable and usable hash.
+
+```ruby
+TenderHash.map(ENV) do
+  map_key 'EMAIL_NOTIFICATIONS', :send_email_notifications, cast_to: :boolean, default: true
+  map_key 'MAPS_API_AUTH_TOKEN', :api_auth_token
+
+  scope :database do
+    map_key 'POSTGRES_URL',      :url, default: 'localhost'
+    map_key 'PORT',              :port, cast_to: :integer, default: 5432
+  end
+end
+
+# => {
+#       send_email_notifications: true,
+#       api_auth_token: 'super-secret',
+#       database: {
+#         url: 'localhost',
+#         port: 5432
+#       }
+#    }
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/rodrei/tender_hash/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+

data/lib/tender_hash/map.rb

@@ -0,0 +1,37 @@
+module TenderHash
+  class Map
+
+    def initialize(hash=nil, &block)
+      @old_hash = hash || {}
+      @rules = []
+      instance_exec(&block) if block_given?
+    end
+
+    def source=(hash)
+      @old_hash = hash
+    end
+
+    def map_key(old, new, options={})
+      @rules << Rule.new(old, new, options)
+    end
+
+    def key(key, options={})
+      map_key(key, key, options)
+    end
+
+    def scope(key, &block)
+      scope = ScopeRule.new(key, &block)
+      @rules << scope
+      scope.map
+    end
+
+    def to_h
+      {}.tap do |new_hash|
+        @rules.each do |rule|
+          rule.apply(@old_hash, new_hash)
+        end
+      end
+    end
+
+  end
+end

data/lib/tender_hash/rule.rb

@@ -0,0 +1,44 @@
+module TenderHash
+  class Rule
+
+    def initialize(old_key, new_key=nil, options={})
+      @old_key = old_key
+      @new_key = new_key || old_key
+      @cast_to = options[:cast_to] && options[:cast_to].to_sym
+      @default = options[:default]
+    end
+
+
+    def apply(old_hash, new_hash)
+      new_value = cast_value(old_hash[@old_key]) unless old_hash[@old_key].nil?
+      new_hash[@new_key] = new_value.nil? ? @default : new_value
+    end
+
+    private
+
+    def cast_value(val)
+      case @cast_to
+      when :integer
+        val.to_i
+      when :string
+        val.to_s
+      when :boolean
+        cast_to_boolean(val)
+      else
+        val
+      end
+    end
+
+    def cast_to_boolean(val)
+      case val
+      when 'true', 1
+        true
+      when 'false', 0
+        false
+      else
+        val
+      end
+    end
+
+  end
+end

data/lib/tender_hash/scope_rule.rb

@@ -0,0 +1,22 @@
+module TenderHash
+  class ScopeRule
+
+    def initialize(key, &block)
+      raise ArgumentError unless block_given?
+      @key = key
+      @block = block
+    end
+
+    def map
+      @map ||= Map.new
+    end
+
+    def apply(old, new, options={})
+      map.source = old
+      map.instance_exec(&@block)
+      new[@key] = map.to_h
+    end
+
+  end
+end
+

data/lib/tender_hash/version.rb

@@ -0,0 +1,3 @@
+module TenderHash
+  VERSION = "0.0.1"
+end

data/lib/tender_hash.rb

@@ -0,0 +1,15 @@
+require "tender_hash/version"
+require "tender_hash/map"
+require "tender_hash/rule"
+require "tender_hash/scope_rule"
+
+module HashMapper
+
+  def self.map(hash, &block)
+    raise ArgumentError unless block_given?
+
+    Map.new(hash, &block).to_h
+  end
+
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'tender_hash'

data/spec/tender_hash/map_spec.rb

@@ -0,0 +1,133 @@
+require 'spec_helper'
+
+describe TenderHash::Map do
+  let(:hash) do { bob: 32, alice: 'cooper', johnny: '13' } end
+  let(:mapper) { TenderHash::Map.new(hash) }
+
+  describe "#to_h" do
+    context "given an empty source hash" do
+      it "returns an new empty hash" do
+        hash = {}
+        TenderHash::Map.new(hash).to_h.tap do |new_hash|
+          expect( new_hash ).to be_empty
+          expect( new_hash ).to_not equal hash
+        end
+      end
+    end
+
+    context "given no rules are specified" do
+      it "returns an empty hash" do
+        hash = { hello: 'there' }
+        expect( TenderHash::Map.new(hash).to_h ).to be_empty
+      end
+    end
+  end
+
+  describe "#key" do
+    it "keeps the specified key" do
+      mapper.key :bob
+      expect( mapper.to_h ).to eql( bob: 32 )
+    end
+
+    it "adds a key with nil value if the key didn't exist in the source hash" do
+      mapper.key :not_existing
+      expect( mapper.to_h ).to eql( not_existing: nil )
+    end
+
+    describe "cast_to option" do
+      it "calls to_i on the mapped value if cast_to is set to integer" do
+        mapper.key :johnny, cast_to: :integer
+        expect( mapper.to_h ).to eql( johnny: 13 )
+      end
+
+      it "calls to_s on the mapped value if cast_to is set to string" do
+        mapper.key :bob, cast_to: :string
+        expect( mapper.to_h ).to eql( bob: '32' )
+      end
+
+      describe "boolean" do
+        it "sets it to true when `true`" do
+          mapper.source = { true: 'true' }
+          mapper.key :true, cast_to: :boolean
+          expect( mapper.to_h ).to eql( true: true )
+        end
+
+        it "sets it to true when equal to 1" do
+          mapper.source = { true: 1 }
+          mapper.key :true, cast_to: :boolean
+          expect( mapper.to_h ).to eql( true: true )
+        end
+
+        it "sets it to false when `false`" do
+          mapper.source = { false: 'false' }
+          mapper.key :false, cast_to: :boolean
+          expect( mapper.to_h ).to eql( false: false )
+        end
+
+        it "sets it to false when equal to 0" do
+          mapper.source = { false: 'false' }
+          mapper.key :false, cast_to: :boolean
+          expect( mapper.to_h ).to eql( false: false )
+        end
+
+        it "doesn't change its value in any other case" do
+          value = double
+          mapper.source = { double: value  }
+          mapper.key :double, cast_to: :boolean
+          expect( mapper.to_h ).to eql( double: value )
+        end
+
+      end
+    end
+
+    describe "default options" do
+      it "disregards the default option when there's a value for the specified key" do
+        mapper.key :bob, default: 'hello'
+        expect( mapper.to_h ).to eql( bob: 32 )
+      end
+
+      it "sets the default when there's no value for the specified key" do
+        mapper.key :new, cast_to: :string, default: "new"
+        expect( mapper.to_h ).to eql( new: 'new' )
+      end
+    end
+  end
+
+  describe "#map_key" do
+    it "updates the key on the return hash" do
+      mapper.map_key :bob, :BOB
+      mapper.map_key :alice, :Alice
+      expect( mapper.to_h ).to eql( BOB: 32, Alice: 'cooper' )
+    end
+  end
+
+  describe "#scope" do
+    it "allows to nest hashes" do
+      mapper.scope :subkey do
+        map_key :bob, :BOB
+      end
+
+      expect( mapper.to_h ).to eql( subkey: { BOB: 32 })
+    end
+
+    it "allows multiple nesting" do
+      mapper.scope :subkey do
+        map_key :alice, :ALICE
+        scope :nested_subkey do
+          key :bob
+        end
+      end
+
+      expect( mapper.to_h ).to eql(
+        {
+          subkey: {
+            ALICE: 'cooper',
+            nested_subkey: { bob: 32 }
+          }
+        }
+      )
+    end
+
+  end
+end
+

data/spec/tender_hash_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe TenderHash do
+  it 'has a version number' do
+    expect(TenderHash::VERSION).not_to be nil
+  end
+end

data/tender_hash.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tender_hash/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tender_hash"
+  spec.version       = TenderHash::VERSION
+  spec.authors       = ["Rodrigo Pavano"]
+  spec.email         = ["rodrigopavano@gmail.com"]
+  spec.summary       = %q{Utility to map a hash following a set of rules and conditions.}
+  spec.description   = %q{TenderHash allows you to map hashes with ease. It offers a nice DSL to define the set of rules used do the mapping.}
+  spec.homepage      = "https://github.com/rodrei/tender_hash"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.3"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: tender_hash
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Rodrigo Pavano
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-08 00:00:00.000000000 Z
+dependencies:
+- !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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: TenderHash allows you to map hashes with ease. It offers a nice DSL to
+  define the set of rules used do the mapping.
+email:
+- rodrigopavano@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/tender_hash.rb
+- lib/tender_hash/map.rb
+- lib/tender_hash/rule.rb
+- lib/tender_hash/scope_rule.rb
+- lib/tender_hash/version.rb
+- spec/spec_helper.rb
+- spec/tender_hash/map_spec.rb
+- spec/tender_hash_spec.rb
+- tender_hash.gemspec
+homepage: https://github.com/rodrei/tender_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: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Utility to map a hash following a set of rules and conditions.
+test_files:
+- spec/spec_helper.rb
+- spec/tender_hash/map_spec.rb
+- spec/tender_hash_spec.rb