normalizr_ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ad4f4f6adc8e503d8fca73d97b300924fb13b19a
+  data.tar.gz: 5e5260114c387d049b7375aadc4e8fc6b8d57f17
+SHA512:
+  metadata.gz: f5790d6d59dbe7bb08ee27c6985748521cc58fd8b639fb12c6c10eb63739264a7b2176eb757541b8ddbe2d722d276daed64ceb7a43760206bd36803a30599d64
+  data.tar.gz: 4d88c5d43d4e2789aeea86dec7dbf3291f0095a94e41c9634c98c0a1ace337a9e0fd9c50282aeb72218a55b13036135c80ef79f1872d609686a50cbae8c18256

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.11.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 shinya takahashi
+
+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,185 @@
+# NormalizrRuby
+[![Build Status](https://travis-ci.org/oreshinya/normalizr_ruby.svg?branch=master)](https://travis-ci.org/oreshinya/normalizr_ruby)
+
+[Normalizr](https://github.com/paularmstrong/normalizr) format JSON generator.
+
+## Installation
+
+```ruby
+gem "normalizr_ruby"
+```
+
+## Getting Started
+
+Include `NormalizrRuby::Normalizable` in your `ApplicationController`:
+
+```ruby
+class ApplicationController < ActionController::API
+  include NormalizrRuby::Normalizable
+end
+```
+
+Create a new normalizr's schema:
+
+```
+bundle exec rails g normalizr_ruby:schema user
+```
+
+This will generate a schema in `app/schemas/user_schema.rb` for your `User` model:
+
+```ruby
+class UserSchema < NormalizrRuby::Schema
+  attribute :id
+end
+```
+
+You can customize it like this:
+
+```ruby
+class UserSchema < NormalizrRuby::Schema
+  attribute :id
+  attribute :first_name
+  attribute :last_name
+  attribute :full_name, if: :has_last_name?
+  association :team
+  association :comments, schema: CustomCommentSchema, if: :has_last_name?
+
+  def full_name
+    "#{object.first_name} #{object.last_name}"
+  end
+
+  def has_last_name?
+    object.last_name.present?
+  end
+end
+```
+
+Render json like this:
+
+```ruby
+class UsersController < Applicationcontroller
+  def index
+    users = User.all
+    render json: users
+  end
+end
+```
+
+You will get response like this:
+
+```json
+{
+  "result": [1, 2],
+  "entities": {
+    "teams": {
+      "1": { "id": 1, "name": "Team A" }
+    },
+    "users": {
+      "1": { "id": 1, "firstName": "Michael", "lastName": "Jackson", "fullName": "Michael Jackson", "team": 1, "comments": [2, 4] },
+      "2": { "id": 2, "firstName": "Tom", "lastName": null, "team": 1 }
+    },
+    "comments": {
+      "2": { "id": 2, "body": "Hello :)" },
+      "4": { "id": 4, "body": "World ;)" }
+    }
+  }
+}
+```
+
+## Documents
+
+### Schema
+#### `::attribute(key, options)`
+Add an attribute to normalized entity.
+`if` option can make an attribute conditional, and it takes a symbol of a method name on the schema.
+
+#### `::association(key, options)`
+Add an association to normalized entity, and add associated entity to entities.
+`if` option can make an association conditional, and it takes a symbol of a method name on the schema.
+`schema` option can make specifying a schema.
+
+#### `#object`
+You can refer unnormalized resource.
+
+#### `#props`
+You can refer arbitray options.
+
+For example:
+
+```ruby
+class UserSchema < NormalizrRuby::Schema
+  attribute :id
+  attribute :hoge
+
+  def hoge
+    props[:arbitray_option]
+  end
+end
+
+def UsersController < Applicationcontroller
+  def show
+    user = User.find(params[:id])
+    render json: user, normalizr: { arbitray_option: 1 }
+  end
+end
+```
+
+#### `#context`
+You can refer any values in all schemas
+
+For example:
+
+```ruby
+class UserSchema < NormalizrRuby::Schema
+  attribute :id
+  attribute :is_current_user
+
+  def is_current_user 
+    context[:current_user].id == object.id
+  end
+end
+```
+
+### Render options
+
+You can pass `normalizr`, and can pass any options as `props`.
+But `schema` option can make specifying a schema.
+
+```ruby
+render json: user, normalizr: { schema: CustomUserSchema, hoge: 1, fuga: 2 }
+```
+
+### How to use context
+
+You have to implement `normalizr_context` in any controller.
+
+```ruby
+class ApplicationController < ActionController::API
+  include NormalizrRuby::Normalizable
+
+  def normalizr_context
+    { current_user: User.first }
+  end
+end
+```
+
+### Configuration
+
+You can specify key transform in your `config/initializers/normalizr_ruby.rb`.
+
+```ruby
+NormalizrRuby.config.key_transform = :camel_lower # default
+```
+
+| Option | Result |
+|----|----|
+| `:camel` | ExampleKey |
+| `:camel_lower` | exampleKey |
+| `:dash` | example-key |
+| `:unaltered` | the original, unaltered key |
+| `:underscore` | example_key |
+| `nil` | use the default |
+
+## License
+
+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 "normalizr_ruby"
+
+# 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/normalizr_ruby/schema/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Generates a schema for the given resource.
+
+Example:
+    rails generate normalizr_ruby:schema user
+
+    This will create:
+        app/schemas/user_schema.rb

data/lib/generators/normalizr_ruby/schema/schema_generator.rb

@@ -0,0 +1,11 @@
+module NormalizrRuby
+  module Generators
+    class SchemaGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+
+      def create_schema
+        template 'schema.rb', File.join('app/schemas', class_path, "#{file_name}_schema.rb")
+      end
+    end
+  end
+end

data/lib/generators/normalizr_ruby/schema/templates/schema.rb

@@ -0,0 +1,5 @@
+<% module_namespacing do -%>
+class <%= class_name %>Schema < NormalizrRuby::Schema
+  attribute :id
+end
+<% end -%>

data/lib/normalizr_ruby/converter.rb

@@ -0,0 +1,50 @@
+module NormalizrRuby
+  class Converter
+    class SchemaNotFound < StandardError; end
+
+    def self.get_schema_class(resource)
+      resource_class_name = resource.class.name
+      schema_class = "#{resource_class_name}Schema".safe_constantize
+      if schema_class.nil?
+        raise SchemaNotFound, "#{resource_class_name} is not found."
+      end
+      schema_class
+    end
+
+    def initialize(context)
+      @context = context
+      @entities = {}
+      @result = nil
+    end
+
+    def normalize(resource, options)
+      opts = options.presence || {}
+      @result = walk(resource, opts)
+      key_transform = NormalizrRuby.config.key_transform
+      normalized_hash = { result: @result, entities: @entities }
+      KeyTransform.send(key_transform, normalized_hash)
+    rescue SchemaNotFound => e
+      resource
+    end
+
+    def walk(resource, options)
+      result = nil
+      if resource.respond_to?(:map)
+        result = resource.map {|r| walk(r, options)}
+      else
+        schema_class = options[:schema].presence || self.class.get_schema_class(resource)
+        schema = schema_class.new(resource, @context, options.except(:schema))
+        result = schema.object.id
+        entity_key = schema.object.class.name.pluralize.to_sym
+        hash = schema.attributes
+        schema.associations.each do |association, assoc_options|
+          association_result = walk(schema.object.send(association), assoc_options)
+          hash[association] = association_result
+        end
+        @entities[entity_key] ||= {}
+        @entities[entity_key][result] = hash
+      end
+      result
+    end
+  end
+end

data/lib/normalizr_ruby/key_transform.rb

@@ -0,0 +1,45 @@
+module NormalizrRuby
+  module KeyTransform
+    module_function
+
+    def camel(value)
+      case value
+      when Hash then value.deep_transform_keys! { |key| camel(key) }
+      when Symbol then camel(value.to_s).to_sym
+      when String then value.underscore.camelize
+      else value
+      end
+    end
+
+    def camel_lower(value)
+      case value
+      when Hash then value.deep_transform_keys! { |key| camel_lower(key) }
+      when Symbol then camel_lower(value.to_s).to_sym
+      when String then value.underscore.camelize(:lower)
+      else value
+      end
+    end
+
+    def dash(value)
+      case value
+      when Hash then value.deep_transform_keys! { |key| dash(key) }
+      when Symbol then dash(value.to_s).to_sym
+      when String then value.underscore.dasherize
+      else value
+      end
+    end
+
+    def underscore(value)
+      case value
+      when Hash then value.deep_transform_keys! { |key| underscore(key) }
+      when Symbol then underscore(value.to_s).to_sym
+      when String then value.underscore
+      else value
+      end
+    end
+
+    def unaltered(value)
+      value
+    end
+  end
+end

data/lib/normalizr_ruby/normalizable.rb

@@ -0,0 +1,15 @@
+module NormalizrRuby
+  module Normalizable
+    extend ActiveSupport::Concern
+    include ActionController::Renderers
+
+    [:_render_option_json, :_render_with_renderer_json].each do |renderer_method|
+      define_method renderer_method do |resource, options|
+        context = respond_to?(:normalizr_context) ? normalizr_context : nil
+        converter = NormalizrRuby::Converter.new(context)
+        normalized_resource = converter.normalize(resource, options[:normalizr])
+        super(normalized_resource, options.except(:normalizr))
+      end
+    end
+  end
+end

data/lib/normalizr_ruby/schema.rb

@@ -0,0 +1,49 @@
+module NormalizrRuby
+  class Schema
+    attr_reader :object, :context, :props
+
+    class_attribute :_attributes
+    class_attribute :_associations
+
+    self._attributes ||= {}
+    self._associations ||= {}
+
+    def self.inherited(child)
+      super
+      child._attributes = _attributes.dup
+      child._associations = _associations.dup
+    end
+
+    def self.attribute(key, options = {})
+      _attributes[key] = options;
+    end
+
+    def self.association(key, options = {})
+      _associations[key] = options;
+    end
+
+    def initialize(object, context, props)
+      @object = object
+      @context = context
+      @props = props
+    end
+
+    def attributes
+      hash = {}
+      self.class._attributes.each do |key, options|
+        next if options[:if] && !send(options[:if])
+        hash[key] = respond_to?(key) ? send(key) : object.send(key)
+      end
+      hash
+    end
+
+    def associations
+      hash = {}
+      self.class._associations.each do |key, options|
+        next if options[:if] && !send(options[:if])
+        hash[key] = options.except(:if)
+      end
+      hash
+    end
+  end
+end

data/lib/normalizr_ruby/version.rb

@@ -0,0 +1,3 @@
+module NormalizrRuby
+  VERSION = "0.1.0"
+end

data/lib/normalizr_ruby.rb

@@ -0,0 +1,15 @@
+require "active_support"
+require "action_controller"
+
+module NormalizrRuby
+  include ActiveSupport::Configurable
+  config_accessor :key_transform do
+    :camel_lower
+  end
+end
+
+require "normalizr_ruby/version"
+require "normalizr_ruby/key_transform"
+require "normalizr_ruby/schema"
+require "normalizr_ruby/converter"
+require "normalizr_ruby/normalizable"

data/normalizr_ruby.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'normalizr_ruby/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "normalizr_ruby"
+  spec.version       = NormalizrRuby::VERSION
+  spec.authors       = ["shinya takahashi"]
+  spec.email         = ["s.takahashi313@gmail.com"]
+
+  spec.summary       = "Normalizr format JSON response generator"
+  spec.description   = "Normalizr format JSON response generator"
+  spec.homepage      = "https://github.com/oreshinya/normalizr_ruby"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport", [">= 5.0", "< 6"]
+  spec.add_dependency "actionpack", [">= 5.0", "< 6"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "activerecord", [">= 5.0", "< 6"]
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "minitest-power_assert"
+end

metadata

@@ -0,0 +1,192 @@
+--- !ruby/object:Gem::Specification
+name: normalizr_ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- shinya takahashi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !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: minitest
+  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: minitest-power_assert
+  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: Normalizr format JSON response generator
+email:
+- s.takahashi313@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/generators/normalizr_ruby/schema/USAGE
+- lib/generators/normalizr_ruby/schema/schema_generator.rb
+- lib/generators/normalizr_ruby/schema/templates/schema.rb
+- lib/normalizr_ruby.rb
+- lib/normalizr_ruby/converter.rb
+- lib/normalizr_ruby/key_transform.rb
+- lib/normalizr_ruby/normalizable.rb
+- lib/normalizr_ruby/schema.rb
+- lib/normalizr_ruby/version.rb
+- normalizr_ruby.gemspec
+homepage: https://github.com/oreshinya/normalizr_ruby
+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: Normalizr format JSON response generator
+test_files: []