simple_object_serializer 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1fcee44d17c35dc6d640675528deb7d27443596c6a0a988590a018445a3848e9
-  data.tar.gz: 99829ab8919be045ab031e0d647d689d47de492d227dc2a132eafc5b7e1a9db4
+  metadata.gz: 15922d9be301e15c4fb01d960126ca5fa107b598a1850c812de306fdfd27a490
+  data.tar.gz: 37f398f4813c09317b4a6191096642849b8f4418dd33f16f4f91f53e51233bb9
 SHA512:
-  metadata.gz: 1261cac7f3278c9fbb035888255e42671eff84cc985d452814a09682f2cd16e425caedd58b73c521019e33c6ed132ce99a8d8b37fce91e7e39d48c2eafef013e
-  data.tar.gz: c7c1619d7741d5141c2bbf671f37c0ea4ba7c06e4e8ecd6948b9ce14d6813fe603885d086c69754d29345abf30bddff6256504ab32a81871ec2b91755c844cd5
+  metadata.gz: ea26178b168e341e650d5041515d9775052f0fcced4c25a8c440c945b1ff784b4db021389e9de79d9b84600e9f701a02b3e136bd9e1ac91ca213da9a6acd7e91
+  data.tar.gz: 3b5b8601174a60cad0fd1d66c32b89c35b6465ace74f11b73579a783f9ce9d116a85c5d1dabd320fefbcac0e9b5e36b15417f3cf23001fa157e908d695216ffc

data/README.MD

@@ -0,0 +1,153 @@
+# Simple Object Serializer
+
+This gem transforms a sequence of objects into one by selecting only the desired properties of them
+
+## Instalation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'simple_object_serializer', git: 'https://github.com/almirpask/simple_object_serializer', branch: 'master'
+```
+Then run the `bunlde` command
+
+## Usage
+For now this gem only provides to you a view helper which you can use to merge your objects eg:
+```ruby
+@user = User.find(2)
+@product = Product.first
+my_car = {
+  brand: 'Ford',
+  model: 'Mustang'
+  fabrication_yar: '2010'
+}
+serialize_objects({user: @user, product: @product, my_car: my_car}, {user: [:name], product: [:name, :price], my_car: [:brand, :model]})
+
+# =>
+{
+  user: {
+    name: 'Nick Fury'
+  },
+  product: {
+    name: 'Chair',
+    price: '40.00'
+  },
+  my_car: {
+    brand: 'Ford',
+    model: 'Mustang'
+  }
+}
+```
+
+### Passing full objects
+To pass full objecets you need to pass a object parameter empty like this:
+
+```ruby
+@user = User.find(2)
+@product = Product.first
+my_car = {
+  brand: 'Ford',
+  model: 'Mustang'
+  fabrication_yar: '2010'
+}
+serialize_objects({user: @user, product: @product, my_car: my_car}, {user: [:name], product: [:name, :price], my_car: []})
+
+# =>
+{
+  user: {
+    name: 'Nick Fury'
+  },
+  product: {
+    name: 'Chair',
+    price: '40.00'
+  },
+  my_car: {
+    brand: 'Ford',
+    model: 'Mustang'
+    fabrication_yar: '2010'
+  }
+}
+```
+
+### Passing a simple array
+
+```ruby
+@user = User.find(2)
+@product = Product.first
+animals = ['dog', 'cat', 'dolphin']
+serialize_objects({user: @user, product: @product, animals: animals}, {user: [:name], product: [:name, :material], animals: []})
+
+# =>
+{
+  user: {
+    name: 'Nick Fury'
+  },
+  product: {
+    name: 'Chair',
+    price: '40.00'
+  },
+  animals: ['dog', 'cat', 'dolphin']
+}
+```
+
+### Passing a array of objects
+
+```ruby
+users = User.all
+
+serialize_objects({users: users}, {users: [:name]})
+
+# =>
+{
+  users: [
+    {
+      name: 'Tonny Stark'
+    },
+    {
+      name: 'Nick Fury'
+    },
+    {
+      name: 'Steve Rogers'
+    }
+  ],
+}
+
+serialize_objects({users: users}, {users: []})
+
+
+# =>
+{
+  users: [
+
+    {
+      id: 1
+      name: 'Tonny Stark',
+      email: 'tonny.stark@avengers.com'
+    },
+    {
+      id: 2
+      name: 'Nick Fury',
+      email: 'nick.fury@avengers.com'
+    },
+    {
+      id: 3
+      name: 'Steve Rogers',
+      email: 'steve.rogers@avengers.com'
+    }
+  ],
+}
+```
+
+
+## TODO
+1. Make this gem run with Active Record relationships
+2. Extend the functionalities to controllers
+3. Allow to pass parameters without having to specify the properties (if exist a parameter without the property specification just show this entire object on results)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/almirpask/simple_object_serializer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/simple_object_serializer/railtie.rb

@@ -0,0 +1,11 @@
+require 'rails'
+
+module SimpleObjectSerializer
+  class Railtie < ::Rails::Railtie
+    initializer 'simple_object_serializer.setup_view_helpers', after: :load_config_initializers, group: :all do
+      ActiveSupport.on_load(:action_view) do
+        include ::SimpleObjectSerializer::ViewHelper
+      end
+    end
+  end
+end

data/lib/simple_object_serializer/view_helper.rb

@@ -0,0 +1,30 @@
+module SimpleObjectSerializer
+  module ViewHelper
+    def serialize_objects(objects, parameters)
+      new_object = {}
+      parameters.each do |parameter_index, parameter|
+        if parameter.empty?
+          new_object[parameter_index] = objects[parameter_index]
+        else
+          if objects[parameter_index].kind_of?(Array)
+            new_object[parameter_index] = []
+            objects[parameter_index].each do |object|
+              array_object = {}
+              parameter.each do |key|
+                array_object[parameter_index] = {} if array_object[parameter_index].nil?
+                array_object[parameter_index][key] = object[key]
+              end
+              new_object[parameter_index] << array_object[parameter_index]
+            end
+          else
+            parameter.each do |key|
+              new_object[parameter_index] = {} if new_object[parameter_index].nil?
+              new_object[parameter_index][key] = objects[parameter_index][key]
+            end
+          end
+        end
+      end
+      new_object
+    end
+  end
+end

data/lib/simple_object_serializer.rb

@@ -1,2 +1,2 @@
-require 'simple_object_serializer/railtie'
 require 'simple_object_serializer/view_helper'
+require 'simple_object_serializer/railtie'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple_object_serializer
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - almirpask
@@ -30,7 +30,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- README.MD
 - lib/simple_object_serializer.rb
+- lib/simple_object_serializer/railtie.rb
+- lib/simple_object_serializer/view_helper.rb
 homepage: https://github.com/almirpask/simple_object_serializer
 licenses:
 - MIT