hashoid 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ab3788f63fb1dd2141d9919258b04f88bd8b52fa
+  data.tar.gz: 149957b26df64dad7b4afe9d9bedd88e035305ee
+SHA512:
+  metadata.gz: 70400942144e911ccc64619e5baa1ce659b0af0793a1eeedc5bc7016e019e6b1a3f56d1754051ecd3c603c0604c43da397e1fffbdb57bd6603d94d5c923f5249
+  data.tar.gz: f9f0149d88d3318f719a61445d4a35a3d152423a430dc4af404a712e0f84101e56b9e1db95aea1c89edd35325d37393bd0517fe555b7cf32fd55100569d44776

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Thibaut Sacreste
+
+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,104 @@
+# Hashoid
+
+Turns your bland json/hashes into flavoursome objects! Useful for consuming web services.
+
+Loosely and shamelessly inspired by Mongoid.
+
+Supports:
+* attribute declaration via `field(s)` and `collection(s)` class methods
+* field type inference from field name (supports name inflection for collections)
+* custom type declaration
+* custom transforms
+* inheritance
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'hashoid'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hashoid
+
+## Usage
+
+```ruby
+require 'hashoid'
+require 'json'
+require 'time'
+
+
+class Country
+  include Hashoid
+  field :name
+end
+
+class Food
+  include Hashoid
+  field :sell_by_date, transform: -> s {Time.parse(s)}
+
+  def out_of_date?
+    sell_by_date < Time.now
+  end
+end
+
+class Cheese < Food
+  fields [:name, :age] 
+  field :origin, type: Country
+
+  def ripe_enough?
+    age > 1
+  end
+end
+
+class CheeseBoard
+  include Hashoid
+  collection :cheeses
+end
+
+cheeseboard_json = '
+  { 
+    "cheeses" : [
+      { 
+        "name" : "Camembert",
+        "age" : 2,
+        "origin" : { "name" : "France" },
+        "sell_by_date" : "2014/04/01"
+      },
+      { 
+        "name" : "Gorgonzola",
+        "age" : 5,
+        "origin" : { "name" : "Italy" },
+        "sell_by_date" : "2014/03/28"
+      }
+    ]
+  }'
+
+cheese_board = CheeseBoard.new(JSON.parse(cheeseboard_json))
+# or easier
+cheese_board = CheeseBoard.from_json(cheeseboard_json)
+
+p cheese_board
+p cheese_board.to_h
+p cheese_board.to_json
+cheese_board.cheeses.each do |cheese|
+  if !cheese.out_of_date? && cheese.ripe_enough?
+    puts "Have some #{cheese.name} from #{cheese.origin.name}. It's ripe!"
+  end
+end
+
+```
+
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

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

data/hashoid.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hashoid/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hashoid"
+  spec.version       = Hashoid::VERSION
+  spec.authors       = ["Thibaut Sacreste"]
+  spec.email         = ["thibaut.sacreste@gmail.com"]
+  spec.description   = "Hashoid: a JSON/Hash to Object Mapper"
+  spec.summary       = "Turns your bland json/hashes into flavoursome objects!"
+  spec.homepage      = "https://github.com/uswitch/hashoid"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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.3"
+  spec.add_development_dependency "rake"
+  spec.add_runtime_dependency "activesupport"
+end

data/lib/hashoid/version.rb

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

data/lib/hashoid.rb

@@ -0,0 +1,123 @@
+require_relative 'hashoid/version'
+require 'active_support/inflector'
+
+module Hashoid
+
+  def self.included base
+    base.extend(ClassMethods)
+  end
+
+  module ClassMethods
+
+    def field name, opts={}
+      _fields[name] = opts.dup
+      attr_reader name
+    end
+
+    def fields names, opts={}
+      names.each{|name| field(name, opts)}
+    end
+
+    def collection name, opts={}
+      field(name, opts.merge(collection: true))
+    end
+
+    def collections names, opts={}
+      names.each{|name| collection(name, opts)}
+    end
+
+    def from_json(json)
+      self.new(JSON.parse(json))
+    end
+    
+    def _fields
+      @fields ||= superclass.respond_to?(:_fields) ? {}.merge(superclass._fields) : {}
+    end
+
+    def is_collection? field
+      _fields[field] && _fields[field][:collection]
+    end
+
+    def field_names
+      _fields.keys
+    end
+
+    def field_type(field, &block)
+      info = _fields[field] ||= {}
+      info[:checked], info[:type] = true, yield unless info[:type] or info[:checked]
+      info[:type]
+    end
+
+    def field_default field
+      _fields[field] && _fields[field][:default]
+    end
+
+    def field_transform field
+      _fields[field] && _fields[field][:transform]
+    end
+
+    def find_class field
+      field_type(field) do
+        class_name = field.to_s.split('_').map(&:capitalize).join
+        class_name = class_name.singularize if is_collection?(field)
+        my_module.const_get(class_name) if my_module.const_defined?(class_name)
+      end
+    end
+  
+    def my_module
+      @my_module ||= (self.name =~ /^(.+)::[^:]+$/) ? $1.constantize : Module
+    end
+  end
+  
+  def initialize args={}
+    self.class._fields.each {|k, _| instance_variable_set("@#{k}", self.class.field_default(k))}
+
+    @args = args
+    args.each do |k, v|
+      field = k.to_s.gsub('-', '_').to_sym
+      unless defined?(field).nil? # check if it's included as a reader attribute
+        result = v.instance_of?(Array) ? init_objects(field, v) : init_object(field, v)
+        instance_variable_set("@#{field}", result) if result
+      end
+    end
+  end
+
+  def each
+    self.class.field_names.map do |f| 
+      [f, self.send(f)]
+    end.reject do |_, v| 
+      v.nil?
+    end.each do |f, v| 
+      yield(f, v)
+    end 
+  end
+
+  def [] field
+    respond_to?(field) ? self.send(field) : @args[field]
+  end
+
+  def to_h
+    @args
+  end
+
+  def to_json
+    to_h.to_json
+  end
+
+  private
+
+  def init_objects field, values
+    values.inject([]) {|arr, v| arr << init_object(field, v)}
+  end
+  
+  def init_object field, value 
+    klass = self.class.find_class(field)
+    value.instance_of?(Hash) && klass ? klass.new(value) : transform(field, value)
+  end
+
+  def transform field, value
+    (value && self.class.field_transform(field)) ? self.class.field_transform(field).call(value) : value
+  end
+    
+end
+

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: hashoid
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Thibaut Sacreste
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 'Hashoid: a JSON/Hash to Object Mapper'
+email:
+- thibaut.sacreste@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- hashoid.gemspec
+- lib/hashoid.rb
+- lib/hashoid/version.rb
+homepage: https://github.com/uswitch/hashoid
+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.3
+signing_key: 
+specification_version: 4
+summary: Turns your bland json/hashes into flavoursome objects!
+test_files: []