deserializer 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e0dd737dc7e4c34c7238b6dc22a16077e17c22d3
-  data.tar.gz: 1d3b4c23174de67667241f4dc91109222bc61d41
+  metadata.gz: 16497e6608bbeeb126c16fbb2040022ef43c2a2e
+  data.tar.gz: de87e7fd93f070278c1b0e3672edbc4363be0560
 SHA512:
-  metadata.gz: d9c5cde9d336f5568761d3d91b39cc697dead376ac6d7f3260da7901aaac333961a71fe7ff1fb0eb7e72446de88b9282e3c850b9c3198aa89fbb92404f2713f0
-  data.tar.gz: bcedd5145f9015da536d2927bed7fcca82d0b39796e78dc7fd6877da719ce2b9f1e5e31a7d5fd2b60c34b4dd5e46fa4d720829046f4eca2c8691a7fdb07e4fa2
+  metadata.gz: b0c1582c067f86f892705e7b7fd73f7ae42dc548354a22170c36b64868febc22a27cba2d306f0130f177062ceb84f548028900d7bb2a086c7be19ec953e7b0ae
+  data.tar.gz: 4883819b21807f2915d8887688786aa3f0aecdaa8c411b750e482e6db14ca8e2a68ea041848424a86a9253b6d885902a4db8e881b4ba43beed332b094226543d

data/.gitignore

@@ -6,3 +6,4 @@ test/dummy/db/*.sqlite3-journal
 test/dummy/log/*.log
 test/dummy/tmp/
 test/dummy/.sass-cache
+coverage

data/Gemfile

@@ -5,11 +5,6 @@ source 'https://rubygems.org'
 # development dependencies will be added by default to the :development group.
 gemspec
 
-# Declare any dependencies that are still in development here instead of in
-# your gemspec. These might include edge Rails or gems from your path or
-# Git. Remember to move these dependencies to your gemspec before releasing
-# your gem to rubygems.org.
-
-# To use a debugger
-# gem 'byebug', group: [:development, :test]
-
+gem 'rake'
+gem 'simplecov', :group => :test
+gem 'minitest', :group => :test

data/Gemfile.lock

@@ -1,106 +1,27 @@
 PATH
   remote: .
   specs:
-    deserializer (0.0.1)
-      rails (~> 4.2.1)
+    deserializer (0.1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionmailer (4.2.3)
-      actionpack (= 4.2.3)
-      actionview (= 4.2.3)
-      activejob (= 4.2.3)
-      mail (~> 2.5, >= 2.5.4)
-      rails-dom-testing (~> 1.0, >= 1.0.5)
-    actionpack (4.2.3)
-      actionview (= 4.2.3)
-      activesupport (= 4.2.3)
-      rack (~> 1.6)
-      rack-test (~> 0.6.2)
-      rails-dom-testing (~> 1.0, >= 1.0.5)
-      rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (4.2.3)
-      activesupport (= 4.2.3)
-      builder (~> 3.1)
-      erubis (~> 2.7.0)
-      rails-dom-testing (~> 1.0, >= 1.0.5)
-      rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    activejob (4.2.3)
-      activesupport (= 4.2.3)
-      globalid (>= 0.3.0)
-    activemodel (4.2.3)
-      activesupport (= 4.2.3)
-      builder (~> 3.1)
-    activerecord (4.2.3)
-      activemodel (= 4.2.3)
-      activesupport (= 4.2.3)
-      arel (~> 6.0)
-    activesupport (4.2.3)
-      i18n (~> 0.7)
-      json (~> 1.7, >= 1.7.7)
-      minitest (~> 5.1)
-      thread_safe (~> 0.3, >= 0.3.4)
-      tzinfo (~> 1.1)
-    arel (6.0.2)
-    builder (3.2.2)
-    erubis (2.7.0)
-    globalid (0.3.5)
-      activesupport (>= 4.1.0)
-    i18n (0.7.0)
-    json (1.8.3)
-    loofah (2.0.2)
-      nokogiri (>= 1.5.9)
-    mail (2.6.3)
-      mime-types (>= 1.16, < 3)
-    mime-types (2.6.1)
-    mini_portile (0.6.2)
+    docile (1.1.5)
     minitest (5.7.0)
-    nokogiri (1.6.6.2)
-      mini_portile (~> 0.6.0)
-    rack (1.6.4)
-    rack-test (0.6.3)
-      rack (>= 1.0)
-    rails (4.2.3)
-      actionmailer (= 4.2.3)
-      actionpack (= 4.2.3)
-      actionview (= 4.2.3)
-      activejob (= 4.2.3)
-      activemodel (= 4.2.3)
-      activerecord (= 4.2.3)
-      activesupport (= 4.2.3)
-      bundler (>= 1.3.0, < 2.0)
-      railties (= 4.2.3)
-      sprockets-rails
-    rails-deprecated_sanitizer (1.0.3)
-      activesupport (>= 4.2.0.alpha)
-    rails-dom-testing (1.0.6)
-      activesupport (>= 4.2.0.beta, < 5.0)
-      nokogiri (~> 1.6.0)
-      rails-deprecated_sanitizer (>= 1.0.1)
-    rails-html-sanitizer (1.0.2)
-      loofah (~> 2.0)
-    railties (4.2.3)
-      actionpack (= 4.2.3)
-      activesupport (= 4.2.3)
-      rake (>= 0.8.7)
-      thor (>= 0.18.1, < 2.0)
+    multi_json (1.11.1)
     rake (10.4.2)
-    sprockets (3.2.0)
-      rack (~> 1.0)
-    sprockets-rails (2.3.2)
-      actionpack (>= 3.0)
-      activesupport (>= 3.0)
-      sprockets (>= 2.8, < 4.0)
-    sqlite3 (1.3.10)
-    thor (0.19.1)
-    thread_safe (0.3.5)
-    tzinfo (1.2.2)
-      thread_safe (~> 0.1)
+    simplecov (0.9.2)
+      docile (~> 1.1.0)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.9.0)
+    simplecov-html (0.9.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  bundler (~> 1.6)
   deserializer!
-  sqlite3
+  minitest
+  rake
+  simplecov

data/README.md

@@ -1,6 +1,6 @@
 # Deserializer
 
-Deserialization of complex parameters into a hash that an AR model can take. 
+Hash transformation and sanitization. Deserialization of complex parameters into a hash that an AR model can take. 
 
 Lets you have a reverse ActiveModel::Sereializer-like interface that allows for easy create and update without having to write heavy controllers.
 
@@ -141,7 +141,7 @@ For example with params of `{"title" => "lorem", "text" => "ipsum"}` this desrer
 
 #### has_one
 NOTE: This is the only association currently supported by `Deserializer`.
-`has_one` expects the param and its deserializer. So for params `{"ratings" => {"taste" => "bad", "smell" => "good"}}`
+`has_one` expects the param and its deserializer.
 ```ruby 
 class DishDeserializer < Deserializer::Base
   # probably other stuff
@@ -153,7 +153,7 @@ class RatingsDeserializer < Deserializer::Base
               :smell
 end
 ```
-you would get `{ratings: {taste: "bad", smell: "good"}}`
+So for params `{"ratings" => {"taste" => "bad", "smell" => "good"}}` you would get `{ratings: {taste: "bad", smell: "good"}}`
 
 #### Overriding Attribute Methods
 So let's say in the example above, your internal representation of ratings inside `Dish` is actually called `scores`, you can do
@@ -166,7 +166,7 @@ class DishDeserializer < Deserializer::Base
   end
 end
 ```
-which will give you `{scores: {taste: "bad", smell: "good"}}`
+which will give you `{scores: {taste: "bad", smell: "good"}}` for params `{"ratings" => {"taste" => "bad", "smell" => "good"}}`
 
 or, if you want to deserialize `ratings` into your `dish` object, you can use `object`
 
@@ -179,7 +179,7 @@ class DishDeserializer < Deserializer::Base
   end
 end
 ```
-which will give you `{taste: "bad", smell: "good"}`
+which will give you `{taste: "bad", smell: "good"}` for params `{"ratings" => {"taste" => "bad", "smell" => "good"}}`
 
 or you can deserialize into another subobject by doing
 ```ruby
@@ -188,7 +188,7 @@ class DishDeserializer < Deserializer::Base
   has_one :ratings, deserializer: RatingsDeserializer
 
   def colors
-    object[:ratings]
+    :ratings
   end
 end
 ```
@@ -263,6 +263,29 @@ class DishReviewsController < YourApiController::Base
     end
   end
 
-  # rest of RUD
+  # RUD
 end
 ```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'deserializer'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install deserializer
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/deserializer/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

@@ -1,31 +1,6 @@
-begin
-  require 'bundler/setup'
-rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
-end
-
-require 'rdoc/task'
-
-RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'Deserializer'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.rdoc')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
-APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
-load 'rails/tasks/engine.rake'
-
-
-load 'rails/tasks/statistics.rake'
-
-
-
-Bundler::GemHelper.install_tasks
-
 require 'rake/testtask'
 
+
 Rake::TestTask.new(:test) do |t|
   t.libs << 'lib'
   t.libs << 'test'
@@ -33,5 +8,4 @@ Rake::TestTask.new(:test) do |t|
   t.verbose = false
 end
 
-
-task default: :test
+task default: :test

data/deserializer.gemspec

@@ -18,4 +18,6 @@ Gem::Specification.new do |s|
   s.test_files    = s.files.grep(%r{^(test|s|features)/})
   s.require_paths = ["lib"]
 
+  s.add_development_dependency "bundler", "~> 1.6"
+  s.add_development_dependency "rake"
 end

data/lib/deserializer/base.rb

@@ -53,7 +53,7 @@ module Deserializer
     def deserialize
       self.class.attrs.each do |param_key, object_key|
         # don't bother with keys that aren't in params
-        next unless params[param_key]
+        next unless params.has_key? param_key
 
         # this checks if the object_key is a class that inherits from Deserializer
         if object_key.is_a?(Class) && object_key < Deserializer::Base
@@ -76,7 +76,7 @@ module Deserializer
         raise DeserializerError, class: self.class, message: "params cannot be nil"
       end
 
-      self.params = params.deep_symbolize_keys
+      self.params = params
       self.object = object
     end
 
@@ -86,10 +86,10 @@ module Deserializer
         target = self.send( association )
         
         unless target.is_a? Hash
-          target = object[target] = {}
+          target = object[target] ||= {}
         end
       else
-        target = object[association] = {}
+        target = object[association] ||= {}
       end
 
       deserializer.new( target, params[association] ).deserialize

data/lib/deserializer/version.rb

@@ -1,3 +1,3 @@
 module Deserializer
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/test/lib/deserializers/deserializers.rb

@@ -0,0 +1,75 @@
+class BasicDeserializer < Deserializer::Base
+  attributes  :user_id,
+              :text
+end
+
+class AttributeDeserializer < Deserializer::Base
+  attribute :user_id, key: :user
+  attribute :text
+end
+
+class VanillaHasOneDeserializer < Deserializer::Base
+  attribute   :internal, key: :external
+
+  has_one :params, deserializer: BasicDeserializer
+  
+end
+
+class HasOneWithTargetDeserializer < Deserializer::Base
+  attribute   :internal, key: :external
+
+  has_one :thing, deserializer: ::BasicDeserializer
+  
+  def thing
+    :user_info
+  end
+end
+
+class OtherThingDeserializer < Deserializer::Base
+  attributes  :attr1,
+              :attr2
+end
+
+class TricksyDeserializer < Deserializer::Base
+  attribute   :internal, key: :external
+
+  has_one :thing, deserializer: ::BasicDeserializer
+  
+  has_one :other_thing, deserializer: ::OtherThingDeserializer
+
+  def thing
+    :user_info
+  end
+
+  def other_thing
+    :user_info
+  end
+end
+
+class ExtraTricksyDeserializer < Deserializer::Base
+  attribute   :internal, key: :external
+
+  has_one :thing, deserializer: ::BasicDeserializer
+  
+  has_one :other_thing, deserializer: ::OtherThingDeserializer
+
+  def other_thing
+    :thing
+  end
+end
+
+class HasOneWithObjectTargetDeserializer < Deserializer::Base
+  attribute   :internal, key: :external
+
+  has_one :thing, deserializer: ::BasicDeserializer
+
+  has_one :other_thing, deserializer: ::OtherThingDeserializer
+  
+  def thing
+    object
+  end
+
+  def other_thing
+    object
+  end
+end

data/test/minitest_helper.rb

@@ -0,0 +1,14 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'simplecov'
+SimpleCov.start
+
+require 'deserializer'
+
+test_libs_path = File.expand_path("../lib", __FILE__)
+Dir[File.join(test_libs_path, "/**/*.rb")].each do |file|
+  puts file
+  require file
+end
+
+require 'minitest/autorun'

data/test/unit/deserializer_error_test.rb

@@ -0,0 +1,12 @@
+require 'minitest_helper'
+
+class DeserializerErrorTest < Minitest::Test
+
+  def test_error_contains_message
+    begin 
+      BasicDeserializer.has_one :lolnope
+    rescue => e
+      assert_equal "BasicDeserializer: has_one associations need a deserilaizer", e.message
+    end
+  end
+end

data/test/unit/deserializer_test.rb

@@ -0,0 +1,100 @@
+require 'minitest_helper'
+
+class DeserializerTest < Minitest::Test
+
+  def setup
+    @params = { user: 6,
+                user_id: 6,
+                text: "text",
+                i_sholdnt_be_here: :should_i_now}
+
+  end
+
+  def test_no_nil_params
+    assert_raises Deserializer::DeserializerError do
+      BasicDeserializer.from_params nil
+    end
+  end
+
+  def test_from_params
+    assert_equal ({user_id: 6, text: "text"}) , BasicDeserializer.from_params( @params )
+  end
+
+  def test_permitted_params
+    assert_equal [:user_id, :text] , BasicDeserializer.permitted_params
+  end
+
+  def test_does_not_eat_false_or_nil_values
+    params = {  user_id: nil,
+                text: false,
+                i_sholdnt_be_here: :should_i_now }
+                
+    assert_equal ({user_id: nil, text: false}) , BasicDeserializer.from_params( params )
+  end
+
+  def test_permitted_params_with_attr_key
+    assert_equal [:user, :text] , AttributeDeserializer.permitted_params
+  end
+
+  def test_attribute
+    assert_equal "text", AttributeDeserializer.from_params( @params )[:text]
+  end
+
+  def test_attribute_with_key
+    assert_equal 6, AttributeDeserializer.from_params( @params )[:user_id]
+  end
+
+  def test_undefined_params_dont_come_through
+    assert_equal nil, AttributeDeserializer.from_params( @params )[:i_shouldnt_be_here]
+  end
+
+  def test_has_one
+    expected = { internal: :thing, params: { user_id: 6, text: "text" }}
+    params   = { external: :thing, params: @params }
+    assert_equal expected, VanillaHasOneDeserializer.from_params( params )
+  end
+
+  def test_has_one_requires_deserializer
+    assert_raises Deserializer::DeserializerError do
+      BasicDeserializer.has_one :splosion
+    end
+  end
+
+  def test_has_one_with_key_target
+    expected = { internal: :thing, user_info: { user_id: 6, text: "text" }}
+    params   = { external: :thing, thing: @params }
+    assert_equal expected, HasOneWithTargetDeserializer.from_params( params )
+  end
+
+  def test_can_combine_two_has_ones_into_a_third_key
+    expected = { internal: :thing, user_info: { user_id: 6, text: "text", attr1: :blah, attr2: :blech }}
+    params   = { external: :thing, thing: @params, other_thing: {attr1: :blah, attr2: :blech} }
+    assert_equal expected, TricksyDeserializer.from_params( params )
+  end
+
+
+  def test_can_merge_a_has_one_into_another
+    expected = { internal: :thing, thing: { user_id: 6, text: "text", attr1: :blah, attr2: :blech }}
+    params   = { external: :thing, thing: @params, other_thing: {attr1: :blah, attr2: :blech} }
+    assert_equal expected, ExtraTricksyDeserializer.from_params( params )
+  end
+
+
+  def test_merge_has_one_into_object
+    expected = { internal: :thing, user_id: 6, text: "text", attr1: :blah, attr2: :blech }
+    params   = { external: :thing, thing: @params, other_thing: {attr1: :blah, attr2: :blech} }
+    assert_equal expected, HasOneWithObjectTargetDeserializer.from_params( params )
+  end
+
+  def test_has_many_unpermitted
+    assert_raises Deserializer::DeserializerError do
+      BasicDeserializer.has_many :explodies
+    end
+  end
+
+  def test_belongs_to_unpermitted
+    assert_raises Deserializer::DeserializerError do
+      BasicDeserializer.belongs_to :explody
+    end
+  end
+end