hashcast 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 33afa8dfdc936c7e5aa452ddaf8f12d82d4f8b14
+  data.tar.gz: 77941ab23bf8ccf44b86464721f4dae049409781
+SHA512:
+  metadata.gz: b2816006132608977f643b2dd6b388f25b693fcaa4928a117fde5b68738234ceec6fc67652bc91b21c238858e1eb6d72ff1890141cc03735b02bc953ec1a1ade
+  data.tar.gz: c06efe176d18c5b259508d12db35c598776c147dc6b0d9e24c93e5117d1407dff2b845ff6ba454ef9a0e37f81b14a4c90a98b6f0062f22d73f0ecd381bd25eb4

data/.gitignore

@@ -0,0 +1,8 @@
+vendor/
+tags
+.bundle
+.DS_Store
+tmp/
+pkg
+.byebug_history
+coverage/

data/.travis.yml

@@ -0,0 +1,3 @@
+rvm:
+- 2.2.0
+script: "bundle exec rspec spec/"

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'rspec'
+end

data/Gemfile.lock

@@ -0,0 +1,50 @@
+PATH
+  remote: .
+  specs:
+    hashcast (0.3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    allocation_stats (0.1.5)
+    bixby-bench (0.1.0)
+      allocation_stats
+    byebug (9.0.6)
+    codecov (0.1.9)
+      json
+      simplecov
+      url
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    json (2.0.2)
+    rake (10.1.1)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.4)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.4)
+    simplecov (0.12.0)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    url (0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  allocation_stats
+  bixby-bench
+  bundler (~> 1.3)
+  byebug
+  codecov
+  hashcast!
+  rake
+  rspec
+
+BUNDLED WITH
+   1.13.6

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Albert Gazizov
+
+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,125 @@
+# HashCast [![Build Status](https://travis-ci.org/ddd-ruby/hashcast.png)](https://travis-ci.org/ddd-ruby/hashcast) [![Code Climate](https://codeclimate.com/github/ddd-ruby/hashcast.png)](https://codeclimate.com/github/ddd-ruby/hashcast) [![codecov](https://codecov.io/gh/ddd-ruby/hashcast/branch/master/graph/badge.svg)](https://codecov.io/gh/ddd-ruby/hashcast)
+
+
+HashCast is a library for casting hash attributes
+
+### Usage
+
+Create caster class and declare hash attributes inside:
+
+```ruby
+class ContactCaster
+  include HashCast::Caster
+
+  attributes do
+    hash :contact do
+      string   :name
+      integer  :age, optional: true
+      float    :weight
+      date     :birthday
+      datetime :last_logged_in
+      time     :last_visited_at
+      hash :company do
+        string :name
+      end
+      array :emails, each: :string
+      array :social_accounts, each: :hash do
+        string :name
+        symbol :type
+      end
+    end
+  end
+end
+```
+
+Instantiate the caster and give your hash for casting:
+
+```ruby
+ContactCaster.cast({
+    contact: {
+      name: "John Smith",
+      age: "22",
+      weight: "65.5",
+      birthday: "2014-02-02",
+      last_logged_in: "2014-02-02 10:10:00",
+      last_visited_at: "2014-02-02 10:10:00",
+      company: {
+        name: "MyCo"
+      },
+      emails: ["test@example.com", "test2@example.com"],
+      social_accounts: [
+        {
+          name: "john_smith",
+          type: "twitter"
+        },
+        {
+          name: "John",
+          type: :facebook
+        }
+      ]
+    }
+  }
+})
+```
+
+The caster will cast your hash attributes to:
+
+```ruby
+{
+  contact: {
+    name: "John Smith",
+    age: 22,
+    weight: 65.5,
+    birthday: #<Date: 2014-02-02 ((2456691j,0s,0n),+0s,2299161j)>,
+    last_logged_in: #<DateTime: 2014-02-02T10:10:00+00:00 ((2456691j,36600s,0n),+0s,2299161j)>,
+    last_visited_at: 2014-02-02 10:10:00 +0400,
+    company: {
+      name: "MyCo"
+    },
+    emails: ["test@example.com", "test2@example.com"],
+    social_accounts: [
+      {
+        name: "john_smith",
+        type: :twitter"
+      },
+      {
+        name: "John",
+        type: :facebook
+      }
+    ]
+  }
+}
+```
+
+if some of the attributes can't be casted the HashCast::Errors::CastingError is raised
+
+
+Also you can provide options to every caster about expected keys type for input/output (:symbol / :string)
+
+```ruby
+class SettingsCaster
+  include HashCast::Caster
+
+  attributes do
+    string :account
+  end
+end
+SettingsCaster.cast({account: "some"}, input_keys: :symbol, output_keys: :string)
+# => {"account" => "some"}
+```
+
+
+## Configuration
+
+
+```ruby
+# expect all input keys to be strings
+HashCast.config.input_keys  = :string
+
+# expect all output keys to be symbols
+HashCast.config.output_keys = :symbol
+```
+
+## Authors
+Albert Gazizov, [@deeper4k](https://twitter.com/deeper4k)
+Roman Heinrich, [@mindreframer](https://twitter.com/mindreframer)

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/benchmark/benchmark.rb

@@ -0,0 +1,66 @@
+# run with `ruby benchmark/benchmark.rb`
+require 'bundler'
+Bundler.setup
+require 'benchmark'
+require 'hcast'
+require 'bixby/bench'
+
+require_relative "casters"
+
+class CastingBenchmark
+  def input_contact
+   @input_contact ||= {
+      contact: {
+        name: "John Smith",
+        age: "22",
+        weight: "65.5",
+        birthday: "2014-02-02",
+        last_logged_in: "2014-02-02 10:10:00",
+        last_visited_at: "2014-02-02 10:10:00",
+        company: {
+          name: "MyCo",
+        },
+        emails: [ "test@example.com", "test2@example.com" ],
+        social_accounts: [
+          {
+            name: "john_smith",
+            type: 'twitter',
+          },
+          {
+            name: "John",
+            type: :facebook,
+          },
+        ]
+      }
+    }
+  end
+
+  def input_company
+    @input_company ||= {
+      name: 'Might & Magic',
+      settings: {
+        account: :'migthy_lord'
+      },
+      emails: [
+        { address: :'test1@example.com' },
+        { address: :'test2@example.com' },
+      ]
+    }
+  end
+
+  def self.run
+    instance = CastingBenchmark.new
+    Bixby::Bench.run(10_000) do |b|
+      b.sample('Contact Caster') do
+        ContactCaster.cast(instance.input_contact)
+      end
+
+      b.sample("CompanyCaster") do
+        CompanyCaster.cast(instance.input_company)
+      end
+    end
+  end
+end
+
+CastingBenchmark.run
+

data/benchmark/casters.rb

@@ -0,0 +1,50 @@
+class ContactCaster
+  include HashCast::Caster
+  attributes do
+    hash :contact do
+      string   :name
+      integer  :age, optional: true
+      float    :weight
+      date     :birthday
+      datetime :last_logged_in
+      time     :last_visited_at
+      hash :company do
+        string :name
+      end
+      array :emails, each: :string
+      array :social_accounts, each: :hash do
+        string :name
+        symbol :type
+      end
+    end
+  end
+end
+
+
+#########
+
+class SettingsCaster
+  include HashCast::Caster
+
+  attributes do
+    string :account
+  end
+end
+
+class EmailCaster
+  include HashCast::Caster
+
+  attributes do
+    string :address
+  end
+end
+
+class CompanyCaster
+  include HashCast::Caster
+
+  attributes do
+    string :name
+    hash   :settings, caster: SettingsCaster
+    array  :emails,  caster: EmailCaster
+  end
+end

data/docs/_config.yml

@@ -0,0 +1 @@
+theme: jekyll-theme-minimal

data/docs/index.md

@@ -0,0 +1,124 @@
+# HashCast [![Build Status](https://travis-ci.org/AlbertGazizov/hcast.png)](https://travis-ci.org/AlbertGazizov/hcast) [![Code Climate](https://codeclimate.com/github/AlbertGazizov/hcast.png)](https://codeclimate.com/github/AlbertGazizov/hcast) [![codecov](https://codecov.io/gh/ddd-ruby/hcast/branch/master/graph/badge.svg)](https://codecov.io/gh/ddd-ruby/hcast)
+
+
+HashCast is a library for casting hash attributes
+
+### Usage
+
+Create caster class and declare hash attributes inside:
+
+```ruby
+class ContactCaster
+  include HashCast::Caster
+
+  attributes do
+    hash :contact do
+      string   :name
+      integer  :age, optional: true
+      float    :weight
+      date     :birthday
+      datetime :last_logged_in
+      time     :last_visited_at
+      hash :company do
+        string :name
+      end
+      array :emails, each: :string
+      array :social_accounts, each: :hash do
+        string :name
+        symbol :type
+      end
+    end
+  end
+end
+```
+
+Instantiate the caster and give your hash for casting:
+
+```ruby
+ContactCaster.cast({
+    contact: {
+      name: "John Smith",
+      age: "22",
+      weight: "65.5",
+      birthday: "2014-02-02",
+      last_logged_in: "2014-02-02 10:10:00",
+      last_visited_at: "2014-02-02 10:10:00",
+      company: {
+        name: "MyCo"
+      },
+      emails: ["test@example.com", "test2@example.com"],
+      social_accounts: [
+        {
+          name: "john_smith",
+          type: "twitter"
+        },
+        {
+          name: "John",
+          type: :facebook
+        }
+      ]
+    }
+  }
+})
+```
+
+The caster will cast your hash attributes to:
+
+```ruby
+{
+  contact: {
+    name: "John Smith",
+    age: 22,
+    weight: 65.5,
+    birthday: #<Date: 2014-02-02 ((2456691j,0s,0n),+0s,2299161j)>,
+    last_logged_in: #<DateTime: 2014-02-02T10:10:00+00:00 ((2456691j,36600s,0n),+0s,2299161j)>,
+    last_visited_at: 2014-02-02 10:10:00 +0400,
+    company: {
+      name: "MyCo"
+    },
+    emails: ["test@example.com", "test2@example.com"],
+    social_accounts: [
+      {
+        name: "john_smith",
+        type: :twitter"
+      },
+      {
+        name: "John",
+        type: :facebook
+      }
+    ]
+  }
+}
+```
+
+if some of the attributes can't be casted the HashCast::Errors::CastingError is raised
+
+
+Also you can provide options to every caster about expected keys type for input/output (:symbol / :string)
+
+```ruby
+class SettingsCaster
+  include HashCast::Caster
+
+  attributes do
+    string :account
+  end
+end
+SettingsCaster.cast({account: "some"}, input_keys: :symbol, output_keys: :string)
+# => {"account" => "some"}
+```
+
+
+## Configuration
+
+
+```ruby
+# expect all input keys to be strings
+HashCast.config.input_keys  = :string
+
+# expect all output keys to be symbols
+HashCast.config.output_keys = :symbol
+```
+
+## Author
+Albert Gazizov, [@deeper4k](https://twitter.com/deeper4k)