ds_doc_wrapper 1.0.2 → 1.0.4

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ODVjZmMxZDlmMjQ2MGYyMDM3NmQ2NTc4ZjA3MGIyMjc1M2QzYmFjMg==
+    MGM3Mzg3ZWMzNzI1OWZhYzNhZDZhMGVlZmNkODc1ZjQ3MDRlYWFlMQ==
   data.tar.gz: !binary |-
-    ZDM4MzIxYjg3OTU2ZTI5Y2YzNDBjZGU5ODQ1N2RjZTg2N2IxYjg3Yw==
+    Mzk1NmQ0OTliODFmNzM3MTY2ZjY0ODhiNmNhNWYwMWI4MjRkOGMzNQ==
 SHA512:
   metadata.gz: !binary |-
-    NTdiYTVmNjA2NjYwNDdkMzQ1ZjEwMDA4MjU5YWVjNTEyYjgzNjY4MTIzNjE0
-    YWQ2MjI3NTBlY2RhNjU4MzQ3ZmIwZThmOGQyYTAwMmRlMjBhYjMxYzczMTFh
-    M2QyYmNmZjdkNzc1MWFjNjFkZjU5OWIxYjZkZDVmNmU0NTQ4OTc=
+    YjBlNDhiZDAyYTc4MjNkYTZiMjE4YjA3ZjUxOTA2YTY0ZTU5ZDgxOTk1MGE2
+    Nzk0ZjViMmU4ZjBkMzJkNjNhMmI0MGE4YzJlMzBkODFkZjU4MzBjMzI3ZGM3
+    YzRkOGI5YTlmZTk2NmQ0MDQ2ZDM5ODFhNTMzMzU0MzE1ZjgzZDc=
   data.tar.gz: !binary |-
-    YzkzYzgzMTRmODIzZGRiY2Q1OThiODA5OGMwODFlNTcwODU0ZjdjMDdiYWU2
-    YjJiM2VlMzNhY2Q1N2QzZjNhOTViZWI4YWE4OGU3MzU4ZWVkNDA4YjUwZjYw
-    M2VhYzI0NjAwZmU0OTZkZWZlMWMzNzlhOGIyODc4ZTkxNTQwYjk=
+    MWJhZjI4ZTI5NWVjMjgwMGUzODA1YzdlODAxYWE4YjZjODc5MTk4MTQ0Y2M3
+    NmY1M2Q5NGEwYzU0ZmQwM2YyN2JhZmE0MDllY2M5NjdjY2ZjZmYwODRjZWI3
+    OTVkZGRhMjExMGZjN2U4ZTYxNzk4ZTE0Y2E4MDE0NDkwNWNiZDk=

data/README.rdoc

@@ -1,3 +1,59 @@
 = DocWrapper
 
-This project rocks and uses MIT-LICENSE.
+This project rocks and uses MIT-LICENSE.
+
+== Description
+
+Doc wrapper, convert a doc in another doc. Doc is some  ruby data structure, like a Hash, Array or a simple String
+
+The advantage is that the conversion engine is automatically identified, making the code cleaner
+
+
+===== Example
+  
+  :001 > DocWrapper.to_target_doc {origin: :sales, user_id: 1, account_id: 99 }   
+  =>  { user: 'John', account_name: 'xxxx' }
+  
+  another example, only changes de origin key
+    :002 > DocWrapper.to_target_doc {owner: :billing, user_id: 1, account_id: 99 }
+    ==> { user_name: 'john', amount: 100.87 }
+
+== Install
+
+  $ gem install ds_doc_wrapper
+  
+== Usage
+
+First you need define some doc wrappers 
+
+  class DocWrapper:DocByTomCat
+    def self.to_target_doc a_doc
+      # --  here put you converter code
+      {
+        tom_cat_name: a_doc['name'],
+        tom_cat_eat: a_doc['food']
+      }
+    end
+  end
+  
+another doc wrapper:
+  
+  class DocWrapper:DocByCook
+    def self.to_target_doc a_doc
+      # --  here put you converter code
+      {
+        name: a_doc['name'],
+        main: a_doc['food']
+      }
+    end
+  end
+  
+  them:
+    :003 > DocWrapper::Base.to_target_doc( { owner: 'tom_cat', 'name' => 'Tom', 'food' => 'fish' } )
+    ==> { tom_cat_name: 'Tom', tom_cat_eat: 'fish' }
+    
+    :004 >  DocWrapper::Base.to_target_doc( { owner: 'cook', 'name' => 'Tom', 'food' => 'fish' } )
+    ==> { name: 'Tom', main: 'fish' }
+    
+    
+    

data/lib/doc_wrapper/version.rb

@@ -1,3 +1,3 @@
 module DocWrapper
-  VERSION = "1.0.2"
+  VERSION = "1.0.4"
 end

data/lib/ds_doc_wrapper.rb

@@ -1,5 +1,5 @@
-
-require 'doc_wrapper/base'
+$:.push File.expand_path("../lib", __FILE__) unless $:.include? File.expand_path("../lib", __FILE__)
 module DocWrapper
+  require 'doc_wrapper/base'
 end
 

data/test/dummy/config/application.rb

@@ -3,7 +3,7 @@ require File.expand_path('../boot', __FILE__)
 require 'rails/all'
 
 Bundler.require(*Rails.groups)
-require "doc_wrapper"
+require "ds_doc_wrapper"
 
 module Dummy
   class Application < Rails::Application

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ds_doc_wrapper
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.4
 platform: ruby
 authors:
 - nardele salomon