japin 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6af1328d766bf07c478bb43343af6fe83707bf7f4a5f8e8f4ca84a604e9a90f8
+  data.tar.gz: 208dcd917e1fe02fbdf9e5c13af89c6ecafc751a5d57c514d29ab78443e0bc30
+SHA512:
+  metadata.gz: ca7a61fb1ae1248c6c26372f492eb9e9600ad50e07e24838db668b6a7e89faa9192586cb93f4d001c64df805651565c4ab87df441db7aabf97d12e8a324feb14
+  data.tar.gz: 928510debaad76e383a7a3234370a93f3a64ce1d1d4ba763595555117d3095daf24f5c20d52d80b74ad8125c49e79c9e396a2738ede836993b1917d9eff7ec0b

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,17 @@
+require:
+  - rubocop-rspec
+  - rubocop-performance
+
+AllCops:
+  TargetRubyVersion: 2.7.2
+  NewCops: enable
+
+Layout/LineLength:
+  Max: 120
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*

data/.ruby-gemset

@@ -0,0 +1 @@
+japin

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.7.2

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in json_api_normalizer.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,79 @@
+PATH
+  remote: .
+  specs:
+    japin (0.1.0)
+      lucky_case (~> 1.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    coderay (1.1.3)
+    diff-lcs (1.4.4)
+    docile (1.3.5)
+    lefthook (0.7.6)
+    lucky_case (1.1.0)
+    method_source (1.0.0)
+    parallel (1.20.1)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rainbow (3.0.0)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.14.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.5.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.9.1)
+      parser (>= 3.0.1.1)
+    rubocop-performance (1.10.2)
+      rubocop (>= 0.90.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rspec (2.2.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    ruby-progressbar (1.11.0)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.2)
+    unicode-display_width (2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  japin!
+  lefthook (~> 0.7.2)
+  pry (~> 0.14.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.14.0)
+  rubocop-performance (~> 1.10.2)
+  rubocop-rspec (~> 2.2.0)
+  simplecov (~> 0.21.2)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Artem Shevchenko
+
+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,93 @@
+# JsonApiNormalizer
+
+Json API Normalizer gem is Ruby implementation of [json-api-normalizer](https://github.com/yury-dymov/json-api-normalizer) provides data normalization and formating for json api response like data.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'json_api_normalizer'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install json_api_normalizer
+
+## Usage
+
+Pass hash to initializer and call `normalize` to normalize data.
+```ruby
+data = { data: { id: '1', type: 'Manga', attributes: { name: "JoJo's Bizarre Adventure Part 6: Stone Ocean" } } }
+JsonApiNormalizer.new(data).normalize
+# output
+# {"Manga"=>{"1"=>{"id"=>"1", "attributes"=>{"name"=>"JoJo's Bizarre Adventure Part 6: Stone Ocean"}, "type"=>"Manga"}}}
+```
+
+You also can call `to_h` which is an alias of `normalize`.
+```ruby
+data = { data: [
+    { id: '1', type: 'Manga', attributes: { name: "JoJo's Bizarre Adventure Part 5: Golden Wind" } },
+    { id: '2', type: 'Manga', attributes: { name: "JoJo's Bizarre Adventure Part 4: Diamond Is Unbreakable" } },
+  ] }
+JsonApiNormalizer.new(data).to_h
+# output
+#{"Manga"=> {
+#  1"=>{"id"=>"1", "attributes"=>{"name"=>"JoJo's Bizarre Adventure Part 5 : Golden Wind"}, "type"=>"Manga"},
+# "2"=>{"id"=>"2", "attributes"=>{"name"=>"JoJo's Bizarre Adventure Part 4: Diamond Is Unbreakable"}, "type"=>"Manga"}
+# } }
+```
+
+Also normalizer supports includes normalization
+```ruby
+data = {
+  data: [
+    { id: 1, type: 'Manga', attributes: { name: "JoJo's Bizarre Adventure Part 3: Stardust Crusaders" },
+      relationships: { author: { data: { id: 1, type: 'Author' } } } },
+    { id: 2, type: 'Manga', attributes: { name: "JoJo's Bizarre Adventure Part 2: Battle Tendency" } ,
+      relationships: { author: { data: { id: 1, type: 'Author' } } } }
+  ],
+  included: [{ id: 1, type: 'Author', attributes: { name: 'Hirohiko Araki' } }]
+}
+JsonApiNormalizer.new(data).to_h
+# output =>
+# {"Manga"=>
+#   {1=>
+#     {"id"=>1,
+#      "attributes"=>{"name"=>"JoJo's Bizarre Adventure Part 3: Stardust Crusaders"},
+#      "type"=>"Manga",
+#      "relationships"=>{"author"=>{"data"=>{"id"=>1, "type"=>"Author"}}}},
+#    2=>
+#     {"id"=>2,
+#      "attributes"=>{"name"=>"JoJo's Bizarre Adventure Part 2: Battle Tendency"},
+#      "type"=>"Manga",
+#      "relationships"=>{"author"=>{"data"=>{"id"=>1, "type"=>"Author"}}}}},
+#  "Author"=>{1=>{"id"=>1, "attributes"=>{"name"=>"Hirohiko Araki"}, "type"=>"Author"}}}
+```
+
+And another feature of normalizer is keys and type case transformation. To see all allowed cases see [lucky_case](https://github.com/magynhard/lucky_case) gem
+```ruby
+data = { data: { id: '1', type: 'Manga', attributes: { name: "JoJo's Bizarre Adventure Part 1: Phantom Blood" } } }
+JsonApiNormalizer.new(data, keys_case: :pascal_case, types_case: :upper_snake_case).normalize
+# output
+# {"MANGA"=>{"1"=>{"Id"=>"1", "Attributes"=>{"Name"=>"JoJo's Bizarre Adventure Part 1: Phantom Blood"}, "Type"=>"MANGA"}}}
+```
+
+Endpoint option is not supported now :(
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Ar2emis/json_api_normalizer.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/benchmark.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+require 'benchmark'
+require_relative 'lib/json_api_normalizer'
+
+json = {
+  data: [
+    {
+      attributes: {
+        yday: 228,
+        text: 'Какие качества Вы больше всего цените в женщинах?',
+        slug: 'tbd'
+      },
+      id: 29,
+      relationships: {
+        'post-blocks': {
+          data: [
+            {
+              type: 'post-block',
+              id: 4601
+            },
+            {
+              type: 'post-block',
+              id: 2454
+            }
+          ]
+        }
+      },
+      type: 'question'
+    }
+  ],
+  included: [
+    {
+      attributes: {},
+      id: 4601,
+      relationships: {
+        user: {
+          data: {
+            type: 'user',
+            id: 1
+          }
+        },
+        posts: {
+          data: [
+            {
+              type: 'post',
+              id: 4969
+            },
+            {
+              type: 'post',
+              id: 1606
+            }
+          ]
+        }
+      },
+      type: 'post-block'
+    },
+    {
+      attributes: {},
+      id: 2454,
+      relationships: {
+        user: {
+          data: {
+            type: 'user',
+            id: 1
+          }
+        },
+        posts: {
+          data: [
+            {
+              type: 'post',
+              id: 4969
+            },
+            {
+              type: 'post',
+              id: 1606
+            }
+          ]
+        }
+      },
+      links: {
+        post_blocks: 'http://link.com'
+      },
+      type: 'post-block'
+    },
+    {
+      type: 'user',
+      attributes: {
+        slug: 'superyuri'
+      },
+      id: 1
+    },
+    {
+      type: 'post',
+      id: 1606,
+      attributes: {
+        text: 'hello1'
+      }
+    },
+    {
+      type: 'post',
+      id: 4969,
+      attributes: {
+        text: 'hello2'
+      },
+      meta: {
+        expires_at: 1_513_868_982
+      }
+    }
+  ]
+}
+
+time = Benchmark.measure do
+  1_000_000.times { JsonApiNormalizer.new(json, keys_case: :camel_case, types_case: :camel_case) }
+end
+
+puts time

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'json_api_normalizer'
+
+require 'pry'
+Pry.start

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/japin.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative 'lib/japin/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'japin'
+  spec.version       = Japin::VERSION
+  spec.authors       = ['Artem Shevchenko']
+  spec.email         = ['artemsheva0510@gmail.com']
+
+  spec.summary       = 'Ruby implementation of NodeJS json-api-normalizer'
+  spec.homepage      = 'https://github.com/Ar2emis/japin'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.7.2')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'lefthook', '~> 0.7.2'
+  spec.add_development_dependency 'pry', '~> 0.14.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 1.14.0'
+  spec.add_development_dependency 'rubocop-performance', '~> 1.10.2'
+  spec.add_development_dependency 'rubocop-rspec', '~> 2.2.0'
+  spec.add_development_dependency 'simplecov', '~> 0.21.2'
+
+  spec.add_dependency 'lucky_case', '~> 1.1.0'
+end

data/lefthook.yml

@@ -0,0 +1,6 @@
+pre-commit:
+  parallel: true
+  commands:
+    rubocop:
+      glob: "*.rb"
+      run: bundle exec rubocop

data/lib/japin.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'lucky_case'
+require_relative 'japin/version'
+require_relative'japin/normalizer'
+
+module Japin
+end

data/lib/japin/normalizer.rb

@@ -0,0 +1,78 @@
+module Japin
+    class Normalizer
+    attr_reader :input, :keys_case, :types_case
+
+    def initialize(input, keys_case: nil, types_case: nil)
+        @input = deep_transform_keys(input, &:to_s)
+        @keys_case = keys_case
+        @types_case = types_case
+    end
+
+    def normalize
+        return @output if @output
+
+        @output = {}
+        input.slice('data', 'included').each_value { |entities| extract_entities(entities) }
+        @output
+    end
+
+    alias to_h normalize
+
+    private
+
+    def extract_entities(json)
+        json.is_a?(Array) ? json.each { |record| extract_entity(record) } : extract_entity(json)
+    end
+
+    def extract_entity(record)
+        type = transform_type_case(record['type'])
+        @output[type] ||= {}
+        data = record.slice('id', 'attributes', 'links', 'meta').merge('type' => type)
+
+        data['relationships'] = extract_relationships(record['relationships']) if record.key?('relationships')
+
+        @output[type][record['id']] ||= process_entity_data(data)
+    end
+
+    def extract_relationships(relationships)
+        relationships.transform_values do |relationship|
+        data = case relationship['data']
+                when Array then relationship['data'].map { |record| process_relationship_data(record) }
+                when Hash then process_relationship_data(relationship['data'])
+                end
+        relationship.slice('links', 'meta').merge('data' => data)
+        end
+    end
+
+    def process_entity_data(data)
+        @keys_case ? deep_transform_keys(data) { |key| transform_key_case(key) } : data
+    end
+
+    def process_relationship_data(data)
+        data.slice('id').merge('type' => transform_type_case(data['type']))
+    end
+
+    def transform_type_case(key)
+        @types_case ? transform_case(key, @types_case) : key
+    end
+
+    def transform_key_case(key)
+        transform_case(key, @keys_case)
+    end
+
+    def transform_case(string, to_case)
+        LuckyCase.convert_case(string, to_case)
+    end
+
+    def deep_transform_keys(object, &block)
+        case object
+        when Hash
+        object.each_with_object({}) do |(key, value), result|
+            result[yield(key)] = deep_transform_keys(value, &block)
+        end
+        when Array then object.map { |element| deep_transform_keys(element, &block) }
+        else object
+        end
+    end
+    end
+end

data/lib/japin/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Japin
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: japin
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Artem Shevchenko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-08-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lefthook
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.2
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.14.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.10.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.10.2
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.2
+- !ruby/object:Gem::Dependency
+  name: lucky_case
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+description: 
+email:
+- artemsheva0510@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-gemset"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- benchmark.rb
+- bin/console
+- bin/setup
+- japin.gemspec
+- lefthook.yml
+- lib/japin.rb
+- lib/japin/normalizer.rb
+- lib/japin/version.rb
+homepage: https://github.com/Ar2emis/japin
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Ar2emis/japin
+  source_code_uri: https://github.com/Ar2emis/japin
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Ruby implementation of NodeJS json-api-normalizer
+test_files: []