objectifier 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 928a6d7f9b3ac93bc01021176a357972f49874fa
+  data.tar.gz: 792a43d2ae0268e0af02fcd31254230a26b7e96c
+SHA512:
+  metadata.gz: f4eca05dfd26f9812fcb053c3453b8f706676e5d914113749881abe441191b6e8fe41d690c5983f3054fc0f8ac533ad21abfe9c98868b0a4d8311fec3e737b43
+  data.tar.gz: 1aa93f41a75c979431ade89d62f1d8a5d43441c528b52555504e39ac890689eb0d39a4edea6f8950b98948dabc559af0b63d5e02a93223da0916920b9c8764be

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.3

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,42 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Nigel Rantor
+
+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,101 @@
+# Objectifier
+
+[![Build Status](https://travis-ci.org/wiggly/objectifier.svg?branch=master)](https://travis-ci.org/wiggly/objectifier)
+
+De-serialise plain hashes into objects.
+
+The rationale behind this is to be able to take input from external sources such as REST calls or log files and turn them into graphs of objects or find out why they cannot be tranformed.
+
+This is the first cut of the code and it currently only handles a small number of types but you can add your own already. Better default types will be coming soon.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'objectifier'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install objectifier
+
+## Usage
+
+Create custom transformers, create an objectifier and use it to de-serialise hashes.
+
+```
+  require 'objectifier'
+  require 'money'
+  
+  # Add a custom tranformer for Money values
+  Objectifier.factories.add_type(
+    Money,
+    ->(name, value) {
+      Objectifier::ValueResult.new(name, Money.new(value["amount"], value["code"]))
+    })
+
+  # define an objectifier that can be used to de-serialise a given format
+  obj = Objectifier.define do
+    item :name, type: String, required: false
+
+    items :accounts, type: Integer
+
+    item :budget, type: Money
+
+    item :length, type: Integer, required: false
+
+    map :activity do
+      item :clicks, type: Integer
+      item :ctr, type: Float
+    end
+  end
+
+  # some test parameters
+  parameters = {
+    "name" => "Billy",
+
+    "accounts" => [ "100", "300", "150", "23" ],
+
+    "budget" => {
+      "amount" => "10.00.0",
+      "code" => "GBP",
+    },
+
+    "length" => "42",
+
+    "activity" => {
+      "clicks" => "83351",
+      "ctr" => "3.1",
+    },
+  }
+
+  # transform input into real objects or return detailed error messages
+  result = obj.call(parameters)
+
+  if result.success?
+    puts result.value
+  else
+    puts result
+  end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/wiggly/objectifier.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "objectifier"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/objectifier.rb

@@ -0,0 +1,16 @@
+require "objectifier/version"
+require "objectifier/result"
+require "objectifier/scalar_value"
+require "objectifier/array_value"
+require "objectifier/map_value"
+require "objectifier/transformer_factory"
+
+module Objectifier
+  def self.factories
+    @factories ||= TransformerFactory.new
+  end
+
+  def self.define(&block)
+    MapValue.new("",&block)
+  end
+end

data/lib/objectifier/array_value.rb

@@ -0,0 +1,73 @@
+require "objectifier/result"
+
+module Objectifier
+  class ArrayValue
+    attr_reader :name, :type
+
+    def initialize(name, **args)
+      raise ArgumentError, "name required" if name.nil?
+      raise ArgumentError, "type required" unless args[:type]
+
+      @name = name.to_s
+      @type = args[:type]
+      @required = args.fetch(:required, true)
+    end
+
+    def required?
+      @required
+    end
+
+    def call(parameters)
+      if @required && !key_present(parameters)
+        ErrorResult.err(@name, "required field missing")
+      elsif key_present(parameters)
+        transform(key_value(parameters))
+      else
+        SuccessResult.new(@name)
+      end
+    end
+
+    def pp(indent = "")
+      "#{indent} #{to_s}"
+    end
+
+    protected
+
+    def key_present(parameters)
+      parameters.has_key?(@name)
+    end
+
+    def key_value(parameters)
+      parameters.fetch(
+        @name,
+        parameters[@name]
+      )
+    end
+
+    def transform(value)
+      return ErrorResult.err(@name, "items must be Array type") unless value.kind_of? Array
+
+
+      # TODO return result type
+      result = value.map { |element| Objectifier.factories.for_type(@type).call(@name, element) }
+
+      values, errors = result.partition do |v|
+        v.success?
+      end
+
+      if errors.empty?
+        xr = values.map do |v|
+          v.value
+        end
+
+        ValueResult.new(@scope, xr)
+      else
+        errors.reduce(ErrorResult.new) { |total, err| total.merge(err) }.scope(@scope)
+      end
+    end
+
+    def to_s
+      "array %s - type: %s - required: %s" % [ @name, @type.to_s, @required.to_s ]
+    end
+  end
+end

data/lib/objectifier/map_value.rb

@@ -0,0 +1,82 @@
+require "objectifier/result"
+
+module Objectifier
+  class MapValue
+    attr_reader :rules
+
+    def initialize(scope = "", &block)
+      @scope = scope.to_s
+      @rules = Hash.new
+      instance_eval &block
+    end
+
+    def name
+      @scope
+    end
+
+    def required?
+      @rules.values.reduce(false) do |req, rule|
+        req || rule.required?
+      end
+    end
+
+    def item(name, **args)
+      @rules[name.to_s] = ScalarValue.new(name, args)
+      true
+    end
+
+    def items(name, **args)
+      @rules[name.to_s] = ArrayValue.new(name, args)
+      true
+    end
+
+    def map(name, &block)
+      @rules[name.to_s] = MapValue.new(name, &block)
+      true
+    end
+
+    def pp(indent = "")
+      next_indent = "#{indent}  "
+      str = "#{indent} #{@scope} {\n"
+      str << @rules.values.map { |r| r.pp(next_indent) }.join("\n")
+      str << "\n#{indent}}\n"
+      str
+    end
+
+    def to_s
+      pp("")
+    end
+
+    # examine parameters and return a hash of massaged data or an error results
+    def call(parameters)
+
+      if @scope.length > 0
+        parameters = parameters.fetch(
+          @scope,
+          parameters.fetch(
+            @scope.to_s,
+            {}))
+      end
+
+      ok, errors = @rules.values.map do |rule|
+        rule.call(parameters)
+      end.partition do |result|
+        result.success?
+      end
+
+      if errors.empty?
+        values = ok.select(&:value?)
+
+        if values.empty?
+          SuccessResult.new(@scope)
+        else
+          ValueResult.new(
+            @scope,
+            Hash[values.map { |v| [ v.name, v.value ] }])
+        end
+      else
+        errors.reduce(ErrorResult.new) { |total, err| total.merge(err) }.scope(@scope)
+      end
+    end
+  end
+end

data/lib/objectifier/result.rb

@@ -0,0 +1,58 @@
+module Objectifier
+  class SuccessResult
+    attr_reader :name
+
+    def initialize(name)
+      @name = name
+    end
+
+    def success?
+      true
+    end
+
+    def value?
+      false
+    end
+  end
+
+  class ValueResult < SuccessResult
+    attr_reader :value
+
+    def initialize(name, value)
+      super(name)
+      @value = value
+    end
+
+    def value?
+      true
+    end
+  end
+
+  class ErrorResult < Hash
+    def initialize
+      super
+    end
+
+    def self.err(name, value)
+      new.tap do |x|
+        x[name] = value
+      end
+    end
+
+    def scope(name)
+      reduce(self.class.new) do |h, kvp|
+        k, v = kvp
+        h[name.to_s+"."+k.to_s] = v
+        h
+      end
+    end
+
+    def success?
+      false
+    end
+
+    def value?
+      false
+    end
+  end
+end

data/lib/objectifier/scalar_value.rb

@@ -0,0 +1,56 @@
+require "objectifier/result"
+
+module Objectifier
+  class ScalarValue
+    attr_reader :name, :type
+
+    def initialize(name, **args)
+      raise ArgumentError, "name required" if name.nil?
+      raise ArgumentError, "type required" unless args[:type]
+      @name = name.to_s
+      @type = args[:type] # TODO: check type is valid?
+      @required = args.fetch(:required, true)
+    end
+
+    def required?
+      @required
+    end
+
+    def call(parameters)
+      if @required && !key_present(parameters)
+        ErrorResult.err(@name, "required field missing")
+      elsif key_present(parameters)
+        transform(key_value(parameters))
+      else
+        # TODO: this is not a failure...
+        SuccessResult.new(@name)
+      end
+    end
+
+    def pp(indent = "")
+      "#{indent} #{to_s}"
+    end
+
+    def to_s
+      "scalar %s - type: %s - required: %s" % [ @name, @type.to_s, @required.to_s ]
+    end
+
+    protected
+
+    def key_present(parameters)
+      parameters.has_key?(@name)
+    end
+
+    def key_value(parameters)
+      parameters.fetch(
+        @name,
+        parameters[@name]
+      )
+    end
+
+    def transform(value)
+      Objectifier.factories.for_type(@type).call(@name, value)
+    end
+
+  end
+end

data/lib/objectifier/transformer_factory.rb

@@ -0,0 +1,26 @@
+require "objectifier/result"
+
+module Objectifier
+  class TransformerFactory
+    def initialize
+      @t = Hash.new { |h,k| raise "unknown type #{@type}" }
+      @t[String] = ->(name, value) { ValueResult.new(name, value.to_s) }
+      @t[Integer] = ->(name, value) {
+        begin
+          ValueResult.new(name, Integer(value))
+        rescue => e
+          ErrorResult.err(name, e.message)
+        end
+      }
+      @t[Float] = ->(name, value) { ValueResult.new(name, value.to_f) }
+    end
+
+    def add_type(type, transformer)
+      @t[type] = transformer
+    end
+
+    def for_type(type)
+      @t[type]
+    end
+  end
+end

data/lib/objectifier/version.rb

@@ -0,0 +1,3 @@
+module Objectifier
+  VERSION = "0.1.0"
+end

data/objectifier.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'objectifier/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "objectifier"
+  spec.version       = Objectifier::VERSION
+  spec.authors       = ["Nigel Rantor"]
+  spec.email         = ["wiggly@wiggly.org"]
+
+  spec.summary       = %q{De-serialize plain hashes into real object graphs}
+  spec.description   = %q{Customize how you de-serialise hashes into real objects.}
+  spec.homepage      = "http://github.com/wiggly/objectifier"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "simplecov"
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: objectifier
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nigel Rantor
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-10-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: 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: guard-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'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: Customize how you de-serialise hashes into real objects.
+email:
+- wiggly@wiggly.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/objectifier.rb
+- lib/objectifier/array_value.rb
+- lib/objectifier/map_value.rb
+- lib/objectifier/result.rb
+- lib/objectifier/scalar_value.rb
+- lib/objectifier/transformer_factory.rb
+- lib/objectifier/version.rb
+- objectifier.gemspec
+homepage: http://github.com/wiggly/objectifier
+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.5.1
+signing_key: 
+specification_version: 4
+summary: De-serialize plain hashes into real object graphs
+test_files: []