fields-serializer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f29199a66db6d606d41313ebf962982b7bcfd4fc
+  data.tar.gz: a91564985913529e305c1fa82c929357d053cd5a
+SHA512:
+  metadata.gz: 4c16d6c243b8946b8c18723d4bf4c03260cf568c750bc2fd6a5884a072650e185f72709b23516220975f9f3102620a104d83e52e5ce19bd7bbf7922879e6783b
+  data.tar.gz: c124dafada87956480064a427147700ed0356c5f276bcef654b478b9e59d22cefd6dc5d23796d239b39b8e3ea84c065aad5ab4e424aca372a20a21e63c8fe0d2

data/.gitignore

@@ -0,0 +1,102 @@
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Gems
+/Gemfile.lock
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+/db/*.sqlite3-journal
+
+# Ignore gem building folder: pkg
+pkg
+
+# Ignore log and tmp files
+log/*
+*.log
+tmp
+tmp/**/*
+
+# Documentation
+/doc/
+doc/api
+doc/app
+.yardoc
+/_yardoc/
+.yardopts
+
+# Public Uploads
+public/system/*
+public/themes/*
+
+# Public Cache
+public/javascripts/cache
+public/stylesheets/cache
+
+# Vendor Cache
+vendor/cache
+
+# Acts as Indexed
+index/**/*
+
+# Refinery Specific
+*.tmproj
+*.autobackupbyrefinery.*
+refinerycms-*.gem
+.autotest
+
+# Mac
+.DS_Store
+
+# Windows
+Thumbs.db
+
+# NetBeans
+nbproject
+
+# Eclipse
+.project
+
+# Redcar
+.redcar
+
+# Rubinius
+*.rbc
+
+# RVM / rbenv
+.ruby-version
+.ruby-gemset
+.rvmrc
+
+# Vim
+*.swp
+*.swo
+
+# RubyMine
+.idea
+
+# E-texteditor
+.eprj
+
+# Backup
+*~
+
+# Capybara Bug
+capybara-*html
+
+# sass
+.sass-cache
+.sass-cache/*
+
+# SimpleCov (tests code converage)
+/coverage
+
+# RSpec
+/spec/reports/
+.rspec_status

data/.rspec

@@ -0,0 +1,4 @@
+--color
+--require byebug
+--require spec_helper
+--format documentation

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.4
+before_install: gem install bundler -v 1.16.0

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in fields-serializer.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Lorenzo Tello
+
+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,57 @@
+# Fields::Serializer
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/fields/serializer`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fields-serializer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fields-serializer
+
+## Usage
+
+Use example in your controller:
+
+```ruby
+class OrdersController < ApplicationController
+  def index
+    orders = Order.all
+    render_json_fields(orders, model_class: Order, fields: ["short_id", "customer.first_name", "customer.surname", "customer.address.postcode"], root: "orders")
+  end
+end
+
+```
+
+If `:model_class` and `:fields` options are included, it will optimize the query to the db using `.includes` based
+on the model_class associations found in `:fields` value. Also, will render only the fields in `:fields` option.
+
+If no :model_class and `:fields` options are provided, it will render the whole objects using the appropriate model
+serializer.
+
+You can also provide any other options accepted by common `render` method.
+
+## 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/ltello/fields-serializer.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://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 "fields/serializer"
+
+# 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(__FILE__)

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/fields-serializer.gemspec

@@ -0,0 +1,33 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "fields/serializer/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "fields-serializer"
+  spec.version       = Fields::Serializer::VERSION
+  spec.authors       = ["Stuart Chinery", "Miguel Montalbo", "Lorenzo Tello"]
+  spec.email         = ["stuart.chinery@gmail.com, mmontalbo@zonedigital.com, ltello8a@gmail.com"]
+
+  spec.summary       = "Extensions to ActiveRecord and ActionController to serialize a subset of model fields"
+  spec.description   = "Extensions to ActiveRecord and ActionController to serialize a subset of model fields"
+  spec.homepage      = "https://github.com/ltello/fields-serializer"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler",      "~> 1.16"
+  spec.add_development_dependency "rake",         "~> 10.0"
+  spec.add_development_dependency "rspec",        "~> 3.6"
+  spec.add_development_dependency "factory_girl", "~> 4.8"
+  spec.add_development_dependency "byebug",       "~> 5.0"
+  spec.add_development_dependency "simplecov"
+
+  spec.add_runtime_dependency     "rails",        "~> 5.0"
+  spec.add_runtime_dependency     "active_model_serializers", "~> 0.10"
+end

data/lib/fields/serializer/action_controller.rb

@@ -0,0 +1,27 @@
+require 'action_controller'
+
+module Fields
+  module Serializer
+    module ActionController
+      extend ActiveSupport::Concern
+
+
+      # Render the result of an ActiveRecord query including only the fields specified if any
+      #   or the whole serialized objects.
+      #
+      # @param  [ActiveRecord_Relation] query - The query to render in json
+      # @option options [Array] :fields       - The list of fields to return in json api syntax
+      # @option options [Class] :model_class  - The model class of the objects to be queried to optimize db hits.
+      # @option options [Hash]  :options      - Any other valid option to render method.
+      def render_json_fields(query, **options)
+        fields      = options.delete(:fields)
+        model_class = options.delete(:model_class)
+        if fields
+          query = query.includes(*model_class.fields_to_includes(fields))
+          options.merge!(each_serializer: FieldSerializer, fields: Array(fields))
+        end
+        render options.merge!(json: query.to_a)
+      end
+    end
+  end
+end

data/lib/fields/serializer/active_record.rb

@@ -0,0 +1,36 @@
+require 'active_record'
+
+module Fields
+  module Serializer
+    module ActiveRecord
+      extend ActiveSupport::Concern
+
+      class_methods do
+        def fields_to_includes(fields)
+          flatten_fields = Array(fields).map { |str| str.to_s.split(",").map(&:strip) }.flatten
+          nested_fields  = flatten_fields.map { |field| nested_field(field.split(".")) }.compact
+          nested_fields.inject([{}]) do |result, attribute_structure|
+            if attribute_structure.is_a?(Hash)
+              result.first.deep_merge!(attribute_structure) { |_, u, v| [u, v] } && result
+            else
+              result << attribute_structure
+            end
+          end.map(&:presence).compact
+        end
+
+        private
+
+        def association?(key)
+          reflections.keys.include?(key)
+        end
+
+        def nested_field(attribute_stack)
+          parent = attribute_stack.first
+          return unless association?(parent)
+          parent_klass = reflections[parent].class_name.constantize
+          { parent => parent_klass.nested_field(attribute_stack[1..-1]) }.compact.presence || parent
+        end
+      end
+    end
+  end
+end

data/lib/fields/serializer/field_serializer.rb

@@ -0,0 +1,39 @@
+require "active_model_serializers"
+
+# This is a generic serializer intended to return a subset of a model's attributes.
+# It can be used with any model but does not currently support associations.
+#
+# Example usage:
+#   `render json: @region, serializer: FieldSerializer, fields: [:id, :title]`
+#
+#   > { "id": "5f19582d-ee28-4e89-9e3a-edc42a8b59e5", "title": "London" }
+
+class FieldSerializer < ActiveModel::Serializer
+  def attributes(*args)
+    adding_id do
+      merging_attributes do
+        args.first.map { |field| create_attribute_structure(field.split("."), object) }
+      end
+    end
+  end
+
+  private
+
+  def adding_id(&block)
+    block.call.merge(id: object.id)
+  end
+
+  def create_attribute_structure(attribute_stack, model)
+    parent = attribute_stack.shift
+    if attribute_stack.count > 0
+      nested_model = model.send(parent)
+      { parent => create_attribute_structure(attribute_stack, nested_model) }
+    else
+      { parent => model.send(parent) }
+    end
+  end
+
+  def merging_attributes(&block)
+    block.call.inject(:deep_merge!)
+  end
+end

data/lib/fields/serializer/version.rb

@@ -0,0 +1,5 @@
+module Fields
+  module Serializer
+    VERSION = "0.1.0"
+  end
+end

data/lib/fields/serializer.rb

@@ -0,0 +1,20 @@
+require 'active_support'
+require 'active_support/core_ext'
+require 'active_support/concern'
+require "fields/serializer/version"
+require "fields/serializer/active_record"
+require "fields/serializer/action_controller"
+require "fields/serializer/field_serializer"
+
+module Fields
+  module Serializer
+
+    ActiveSupport.on_load(:active_record) do
+      include Fields::Serializer::ActiveRecord
+    end
+
+    ActiveSupport.on_load(:action_controller) do
+      include Fields::Serializer::ActionController
+    end
+  end
+end

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: fields-serializer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Stuart Chinery
+- Miguel Montalbo
+- Lorenzo Tello
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-12-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.8'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.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'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: active_model_serializers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+description: Extensions to ActiveRecord and ActionController to serialize a subset
+  of model fields
+email:
+- stuart.chinery@gmail.com, mmontalbo@zonedigital.com, ltello8a@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- fields-serializer.gemspec
+- lib/fields/serializer.rb
+- lib/fields/serializer/action_controller.rb
+- lib/fields/serializer/active_record.rb
+- lib/fields/serializer/field_serializer.rb
+- lib/fields/serializer/version.rb
+homepage: https://github.com/ltello/fields-serializer
+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.6.13
+signing_key: 
+specification_version: 4
+summary: Extensions to ActiveRecord and ActionController to serialize a subset of
+  model fields
+test_files: []