serializr 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 41ea89e74e081490d15d51602f036231410bd996
+  data.tar.gz: 1b6e49a40938681ed7526e83ec76ba3d1597bb7f
+SHA512:
+  metadata.gz: 59e11f40d0aed5c14189b0f3a9db99c1878207b7c77ee99669584bdf5c13ab98405d34b078828447c56aa36183fd44d6e42ea7a7e37323405343136dbae61f78
+  data.tar.gz: 7adc1cc8275f63e20f1e135345faad18aedb11ccfd92b436379be6cd5ac2ea45082b6d74d56bdbbaf2a4ef1d4663e779e85dc9678ba8ca1d867d38681597857d

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at gsamokovarov@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in serializr.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Genadi Samokovarov
+
+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,176 @@
+# Serializr
+
+Serializr is a library for creating canonical JSON representation of objects
+for your RESTful APIs.
+
+Think of the serializers as the view layer of your application. They are not
+the only JSON representation of an object, but they are _the_ representation
+you wanna show to the API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'serializr'
+```
+
+## Usage
+
+Using the serializr library is pretty simple. To generate your first
+serializer, execute:
+
+    $ rails generate serializr User id name email
+
+The output should hint that the generator created two files:
+
+    create  app/serializers/application_serializer.rb
+    create  app/serializers/user_serializer.rb
+
+The `app/serializers/user_serializer.rb` file should contain:
+
+```ruby
+class UserSerializer < ApplicationSerializer
+  attributes :id, :name, :email
+end
+```
+
+This says: expect the object to be serialized to respond to `#id`, `#name` and
+`#email` and show the resulting JSON as:
+
+```json
+{
+  "id": 42,
+  "name": "John Doe",
+  "email": "john@nsa.gov"
+}
+```
+
+Oh, wait... Your users don't respond to `#name`?
+
+```ruby
+class UserSerializer < ApplicationSerializer
+  attributes :id, :name, :email
+
+  def name
+    "#{object.first_name} #{object.last_name}"
+  end
+end
+```
+
+That's fine. Your serializers can render fields your object don't respond to.
+
+Now, to render the JSON object, you need to say the following in your
+controller:
+
+```ruby
+class UsersController < ApplicationController
+  def show
+    user = User.find(params[:id])
+
+    render json: user
+  end
+end
+```
+
+The serializr library hooks itself into `ActionController::Base` or
+`ActionController::API` and it can infer the `UserSerializer` out of the `User`
+object. You can also be explicit, in which case the inferring logic won't be
+triggered at all.
+
+```ruby
+class UsersController < ApplicationController
+  def show
+    user = User.find(params[:id])
+
+    render json: user, serializer: UserSerializer
+  end
+end
+```
+
+You can also render collections of objects:
+
+```ruby
+class FriendsController < ApplicationController
+  def index
+    user = User.friends_of(params[:id])
+
+    render json: friends
+  end
+end
+```
+
+Being explicit here may have performance benefits, as to guess the Serializer
+class to use, we need to unroll the collection. The explicit usage, unarguably,
+looks pretty awesome as well, so you can wow your friends! Which, is always
+cool, you know. 😎
+
+```ruby
+class FriendsController < ApplicationController
+  def index
+    user = User.friends_of(params[:id])
+
+    render json: friends, serializer: UserSerializer[]
+  end
+end
+```
+
+And this is how you drop `Action View` off your API's, kids!
+
+(_Not really, but anyway, I have the stage now, I do the typing. Fuck off and
+call my therapist!_)
+
+### 1️⃣  Last Thing
+
+To fill the API cliché, we need to go over one last file:
+`app/serializers/application_serializer.rb`. At first, it looks like this:
+
+```ruby
+class ApplicationSerializer < Serializr
+end
+```
+
+The grown ups call it [Layer
+Supertype](http://martinfowler.com/eaaCatalog/layerSupertype.html). We'll call
+it that thing that looks like `ApplicationController` and serves the same
+purpose, but for the serializers, not the controllers. You can use it to put
+common utilities shared by all the serializers.
+
+For example:
+
+```ruby
+class ApplicationSerializer < Serializr
+  # You may need the routes helpers, so you can link between resources in your
+  # JSON responses.
+  inlcude Rails.application.routes.url_helpers
+
+  EPOCH_TIME = Time.at(0).in_time_zone('UTC')
+
+  # You may wanna render this timestamp instead of `null` for unset timestamps.
+  # Or do whatever, really. I'm not your parents.
+  def render_timestamp(timestamp)
+    timestamp || EPOCH_TIME
+  end
+end
+```
+
+### 1️⃣  Last Thing, For Real This Time
+
+Serializr? Really? I know. It's fine.
+
+You can require `serializr`, you can require `serializer` as well. The
+constants? Both of `Serializr` and `Serializer` point to the same thing. Same
+for the generators. Use whatever your brain and 🖐 like.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/gsamokovarov/serializr. 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](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "serializr"
+
+# 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

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/lib/generators/serializer/USAGE

@@ -0,0 +1,19 @@
+Description:
+    Stubs out a new serializer. Pass the serializer name, either CamelCased or
+    under_scored and an optional list of attribute pairs as arguments.
+
+    Attribute pairs are field arguments specifying the exposed serializer's
+    JSON object attributes.
+
+    Finally, if --parent option is given, it's used as superclass of the
+    created serializer. The default parent is ApplicationSerializer, that you
+    can use in the same way ApplicationController: a place for common utilities
+    shared between all the serializers.
+
+Example:
+    `rails generate serializer User`
+
+        This will create:
+
+            app/serializers/application_serializer.rb
+            app/serializers/user_serializer.rb

data/lib/generators/serializer/serializer_generator.rb

@@ -0,0 +1,5 @@
+require_relative '../serializr/serializr_generator'
+
+class SerializerGenerator < SerializrGenerator
+  source_root File.expand_path('../../serializr/templates', __FILE__)
+end

data/lib/generators/serializr/USAGE

@@ -0,0 +1,19 @@
+Description:
+    Stubs out a new serializer. Pass the serializer name, either CamelCased or
+    under_scored and an optional list of attribute pairs as arguments.
+
+    Attribute pairs are field arguments specifying the exposed serializer's
+    JSON object attributes.
+
+    Finally, if --parent option is given, it's used as superclass of the
+    created serializer. The default parent is ApplicationSerializer, that you
+    can use in the same way ApplicationController: a place for common utilities
+    shared between all the serializers.
+
+Example:
+    `rails generate serializer User`
+
+        This will create:
+
+            app/serializers/application_serializer.rb
+            app/serializers/user_serializer.rb

data/lib/generators/serializr/serializr_generator.rb

@@ -0,0 +1,47 @@
+require 'pathname'
+
+class SerializrGenerator < Rails::Generators::NamedBase
+  SERIALIZR_DIR = Pathname.new('app/serializers')
+
+  source_root File.expand_path('../templates', __FILE__)
+
+  argument :attributes, type: :array, default: [], banner: 'field field'
+
+  check_class_collision suffix: 'Serializer'
+  class_option :parent, type: :string, desc: 'The parent class for the generated serializr'
+
+  def create_serializer_file
+    generate_application_serilzer unless non_standard_parent_class_name?
+    template 'serializr.rb', serializer_file_name
+  end
+
+  private
+
+  def parent_class_name
+    options[:parent] || 'ApplicationSerializer'
+  end
+
+  def non_standard_parent_class_name?
+    parent_class_name != 'ApplicationSerializer'
+  end
+
+  def generate_application_serilzer
+    if self.behavior == :invoke && !application_serilzer_exist?
+      template 'application_serializr.rb', application_serilzer_file_name
+    end
+  end
+
+  def application_serilzer_exist?
+    file_exist = nil
+    in_root { file_exist = File.exist?(application_serilzer_file_name) }
+    file_exist
+  end
+
+  def serializer_file_name
+    SERIALIZR_DIR.join(*class_path, "#{file_name}_serializer.rb").to_s
+  end
+
+  def application_serilzer_file_name
+    SERIALIZR_DIR.join('application_serializer.rb').to_s
+  end 
+end

data/lib/generators/serializr/templates/application_serializr.rb

@@ -0,0 +1,4 @@
+<% module_namespacing do -%>
+class ApplicationSerializer < Serializr
+end
+<% end -%>

data/lib/generators/serializr/templates/serializr.rb

@@ -0,0 +1,7 @@
+<% module_namespacing do -%>
+class <%= class_name %>Serializer < <%= parent_class_name %>
+  <% if attributes.present? %>
+  attributes <%= attributes.map { |a| a.name.to_sym.inspect }.join(', ') %>
+  <% end %>
+end
+<% end -%>

data/lib/serializer.rb

@@ -0,0 +1 @@
+require 'serializr'

data/lib/serializr/integration.rb

@@ -0,0 +1,44 @@
+class Serializr
+  # Integration for AbstactController::Metal subclasses like
+  # ActionController::Base or ActionController::API.
+  #
+  # Introduces a `:serializer` option that is automatically inferred by the
+  # resource to be rendered in `render :json`.
+  #
+  # Setting it explicitly prevents the inferring altogether.
+  module Integration
+    def _normalize_options(options)
+      # The resource can be nil, check if it is explicitly passed as such.
+      if options.key?(:json)
+        resource = options[:json]
+        serializer = options[:serializer] || begin
+          if resource.respond_to?(:to_ary)
+            # Assume a collection if the resource responds to #to_ary. The
+            # regular arrays and ActiveRecord::Relations do and will be
+            # represented as arrays, while hashes won't be.
+            inferred = serializer_class_cache[resource.to_ary.first.class]
+            inferred[] if inferred
+          else
+            serializer_class_cache[resource.class]
+          end
+        end
+
+        options[:json] = serializer.new(resource, options) if serializer
+      end
+
+      super
+    end
+
+    private
+
+    def serializer_class_cache
+      @@_serializer_class_cache ||= Hash.new do |hash, cls|
+        hash[cls] = "#{cls}Serializer".safe_constantize ||
+          # Try to infer the superclass, if someone let a serializer for it and
+          # not the concrete classes. Don't go deeper, though, just one level
+          # is enough.
+          "#{cls.superclass}Serializer".safe_constantize
+      end
+    end
+  end
+end

data/lib/serializr/railtie.rb

@@ -0,0 +1,14 @@
+class Serializr
+  class Railtie < ::Rails::Railtie
+    initializer 'serializr.initialize' do
+      require 'serializr/integration'
+
+      # For Rails 5, automatically include this in the API controllers.
+      if defined?(ActionController::API)
+        ActionController::API.include(::Serializr::Integration)
+      end
+
+      ActionController::Base.include(::Serializr::Integration)
+    end
+  end
+end

data/lib/serializr/version.rb

@@ -0,0 +1,3 @@
+class Serializr
+  VERSION = '0.1.0'
+end

data/lib/serializr.rb

@@ -0,0 +1,65 @@
+class Serializr
+  class << self
+    NOT_GIVEN = Object.new
+
+    def [](object = NOT_GIVEN, options = {})
+      cls = collection_class_cache[self]
+      object == NOT_GIVEN ? cls : cls.new(object, options)
+    end
+
+    def attributes(*attr_names)
+      if attr_names.empty?
+        @attrs ||= []
+      else
+        (@attrs ||= []).concat(attr_names)
+        attr_names.each { |attr| define_attribute_method(attr) }
+      end
+    end
+
+    private
+
+    def inherited(cls)
+      return if self == Serializr
+
+      attrs_copy = [].concat(@attrs ||= [])
+      cls.instance_variable_set(:@attrs, attrs_copy)
+    end
+
+    def collection_class_cache
+      @collection_class_cache ||= Hash.new do |hash, cls|
+        hash[cls] = Class.new(cls) do
+          def as_json
+            serializer = self.class.superclass
+            object.map { |obj| serializer.new(obj, options).as_json }
+          end
+        end
+      end
+    end
+
+    def define_attribute_method(attr_name)
+      class_eval <<-RUBY, __FILE__, __LINE__ + 1
+        def #{attr_name}() object.#{attr_name} end
+      RUBY
+    end
+  end
+
+  def initialize(object, options = {})
+    @object  = object
+    @options = options
+  end
+
+  def as_json
+    Hash[self.class.attributes.map do |attr|
+      [attr, public_send(attr).as_json]
+    end]
+  end
+
+  private
+
+  attr_reader :object, :options
+end
+
+# Let's get the constant, even if we don't explicitly `require 'serializer'`.
+Serializer = Serializr
+
+require 'serializr/railtie' if defined?(Rails)

data/serializr.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'serializr/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "serializr"
+  spec.version       = Serializr::VERSION
+  spec.authors       = ["Genadi Samokovarov"]
+  spec.email         = ["gsamokovarov@gmail.com"]
+
+  spec.summary       = "Plain and simple JSON serializer."
+  spec.description   = "Plain and simple JSON serializer."
+  spec.homepage      = "https://github.com/gsamokovarov/serializr"
+  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.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "rails", "~> 5.0"
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: serializr
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Genadi Samokovarov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-11-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: minitest
+  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: rails
+  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'
+description: Plain and simple JSON serializer.
+email:
+- gsamokovarov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/generators/serializer/USAGE
+- lib/generators/serializer/serializer_generator.rb
+- lib/generators/serializr/USAGE
+- lib/generators/serializr/serializr_generator.rb
+- lib/generators/serializr/templates/application_serializr.rb
+- lib/generators/serializr/templates/serializr.rb
+- lib/serializer.rb
+- lib/serializr.rb
+- lib/serializr/integration.rb
+- lib/serializr/railtie.rb
+- lib/serializr/version.rb
+- serializr.gemspec
+homepage: https://github.com/gsamokovarov/serializr
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Plain and simple JSON serializer.
+test_files: []