to_j 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3736fab4fbb92872ce6b30d5cb1b382b1b08d69a
+  data.tar.gz: 18b7d07c59748f4db9ea250249926d4c99f015fa
+SHA512:
+  metadata.gz: 0c4f03865d620a4b581f566c835367c67b7d359ccf2332b5bf4bc6554594ae2f9c088713d67bf2e7f595e4a8b7d2050517bb36c80f0170b90b835d09ca428bed
+  data.tar.gz: d6b53b1bb4bc0fbbc41507a8f7b6a101775cb6ac24da79570c9704005078c25af27e315be684d81e88f0c92ed75f1b2508f03b51393dcf24c946227a2f91a001

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 pioz
+
+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,153 @@
+# ToJ
+
+ToJ is a helpful gem that allow you to build json from your active model
+object or collection. ToJ allow you to define a Serializer with many methods
+called `views`. A view is a method that describe how to generate the json. So
+if you want generate a json with only the author data you can use
+`author.to_j`, but if you want add also the books you can use
+`author.to_j(view: :with_books)`.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'to_j'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install to_j
+```
+
+## Usage
+
+In your models include the ToJ module:
+
+```ruby
+class Author < ApplicationRecord
+  include ToJ
+  has_many :books, dependent: :destroy
+end
+
+class Book < ApplicationRecord
+  include ToJ
+  belongs_to :author
+
+  def nice_title
+    self.title.titleize
+  end
+end
+```
+
+Then in the `app/serializers` directory create a serializer for each model:
+
+```ruby
+# app/serializers/author_serializer.rb
+module AuthorSerializer
+
+  def default(author, options = {})
+    self.extract!(author, :id, :name)
+    if options[:user].try(:admin?)
+      self.extract!(author, :email)
+    end
+  end
+
+  def with_books(author, options = {})
+    default(author, options)
+    self.books do
+      self.array!(author.books.map{|book| book.to_j(options)})
+    end
+  end
+
+end
+```
+
+```ruby
+# app/serializers/book_serializer.rb
+module BookSerializer
+
+  def default(book, options = {})
+    self.extract!(book, :id, :title, :nice_title)
+  end
+
+  def only_title(book, options = {})
+    self.extract!(book, :title)
+  end
+
+end
+```
+
+The default view is called if the option `:view` is not present on `to_j`
+options param.
+
+Now you can call:
+
+```ruby
+Author.limit(100).to_j
+# [{"id"=>1028680, "name"=>"Kristopher", {...}, ...]
+Author.limit(100).to_j(view: :with_books)
+# [{"id"=>1028680, "name"=>"Kristopher", "books"=>[{"id"=>192756823, "title"=>"If not now, when?", "nice_title"=>"If Not Now, When?"}, {...}, ...]
+Book.first.to_j(view: :only_title)
+# {"title"=>"Jesting pilate"} 
+```
+
+or in your controllers:
+
+```ruby
+
+def index
+  @authors = Author.limit(100)
+  respond_to do |format|
+    format.html
+    format.json { render json: @authors.to_j(user: current_user) }
+  end
+end
+
+def show
+  @author = Author.find(params[:id])
+  respond_to do |format|
+    format.html
+    format.json { render json: @author.to_j(view: :with_books) }
+  end
+end
+
+```
+
+If a serializer or `default` method is not defined all table columns will be
+added in the json (default Rails behaviour).
+
+### Under the Hood there is Jbuilder
+
+The `self` object in serializer's methods are a Jbuilder object so you can use
+the [Jbuilder](https://github.com/rails/jbuilder/) DSL to create and
+personalized your json views.
+
+## Performance
+
+In the `test` directory I've write a simple benchmark to check the performance of this gem with other common serializers:
+* [as_json](http://api.rubyonrails.org/classes/ActiveModel/Serializers/JSON.html#method-i-as_json)
+* [active_model_serializers](https://github.com/rails-api/active_model_serializers/)
+* [Jbuilder](https://github.com/rails/jbuilder/)
+
+Here the results to build a json of `10_000` authors with a total of `100_000` books:
+
+```
+Run options: --seed 333
+
+# Running:
+
+         user        system    total     real
+to_j      9.950000   0.340000  10.290000 ( 10.367328)
+as_json  15.460000   0.400000  15.860000 ( 15.942882)
+ams      16.000000   0.460000  16.460000 ( 16.578348)
+jbuilder  9.940000   0.380000  10.320000 ( 10.305331)
+
+```
+
+## 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,27 @@
+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    = 'ToJ'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/tasks/to_j_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :to_j do
+#   # Task goes here
+# end

data/lib/to_j.rb

@@ -0,0 +1,40 @@
+require "to_j/railtie"
+
+module ToJ
+  extend ActiveSupport::Concern
+
+  included do
+    klass_name = self.name
+    proxy = Class.new do
+      include "#{klass_name}Serializer".constantize rescue nil
+      def initialize
+        @json = Jbuilder.new
+        yield(self) if block_given?
+      end
+      def method_missing(method, *args, &block)
+        @json.__send__(method, *args, &block)
+      end
+    end
+    Object.const_set("#{klass_name}JbuilderProxy", proxy)
+
+    def self.to_j(options = {})
+      Jbuilder.new do |json|
+        json.array!(current_scope.map { |obj| obj.to_j(options) })
+      end.attributes!
+    end
+
+    def to_j(options = {})
+      view = options[:view] || :default
+      json = "#{self.class.name}JbuilderProxy".constantize.new
+      if json.respond_to?(view)
+        json.send(view, self, options.except(:view))
+      elsif view != :default
+        raise "Serializer view :#{view} does not exist!"
+      else
+        json.(self, *self.class.column_names)
+      end
+      return json.attributes!
+    end
+    
+  end
+end

data/lib/to_j/railtie.rb

@@ -0,0 +1,4 @@
+module ToJ
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/to_j/version.rb

@@ -0,0 +1,3 @@
+module ToJ
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: to_j
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- pioz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-05-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: factory_bot_rails
+  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: faker
+  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: oj
+  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: jbuilder
+  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: active_model_serializers
+  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: Fast JSON serializer for Rails based on Jbuilder and concept of view
+email:
+- epilotto@gmx.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/tasks/to_j_tasks.rake
+- lib/to_j.rb
+- lib/to_j/railtie.rb
+- lib/to_j/version.rb
+homepage: https://github.com/pioz/to_j
+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: Fast JSON serializer for Rails based on Jbuilder and concept of view
+test_files: []