seri 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 235047fde67dba9419cb66b80ae8bf6ab57f167dd56221b6deaace66967d2997
+  data.tar.gz: a2a7b26b30531f9633feec79dde2ae10f64aad7eb49926078d0b925fb5d28a61
+SHA512:
+  metadata.gz: 0d86a1667787e7e807d87675196b254bfd686e18da9e9cba6636c0a6c6345771295edab70645456c70e80418c184dc0570ab2095c8cb57d52b3af91e4b13a367
+  data.tar.gz: d9e9fb1aed4e27f70674e6795035b36428f5a6ab5ac15341fff02a883a0db25a8a584ee6243f192d913cd1b3515f867761361a44bf20a39e0579c703c0fd8ab8

data/.circleci/config.yml

@@ -0,0 +1,55 @@
+# Ruby CircleCI 2.0 configuration file
+#
+# Check https://circleci.com/docs/2.0/language-ruby/ for more details
+#
+version: 2
+jobs:
+  build:
+    docker:
+      # specify the version you desire here
+       - image: circleci/ruby:2.4.1-node-browsers
+
+      # Specify service dependencies here if necessary
+      # CircleCI maintains a library of pre-built images
+      # documented at https://circleci.com/docs/2.0/circleci-images/
+      # - image: circleci/postgres:9.4
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+
+      # Download and cache dependencies
+      - restore_cache:
+          keys:
+          - v1-dependencies-{{ checksum "Gemfile.lock" }}
+          # fallback to using the latest cache if no exact match is found
+          - v1-dependencies-
+
+      - run:
+          name: install dependencies
+          command: |
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
+
+      # run tests!
+      - run:
+          name: run tests
+          command: |
+            mkdir /tmp/test-results
+            TEST_FILES="$(circleci tests glob "spec/**/*_spec.rb" | circleci tests split --split-by=timings)"
+
+            bundle exec rspec --format progress \
+                            --out /tmp/test-results/rspec.xml \
+                            --format progress \
+                            $TEST_FILES
+
+      # collect reports
+      - store_test_results:
+          path: /tmp/test-results
+      - store_artifacts:
+          path: /tmp/test-results

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/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.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 gerard@wetransfer.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,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in seri.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,41 @@
+PATH
+  remote: .
+  specs:
+    serializer (0.1.0)
+      appsignal (~> 2.7)
+      oj (~> 3.7)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    appsignal (2.7.2)
+      rack
+    diff-lcs (1.3)
+    oj (3.7.4)
+    rack (2.0.6)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  serializer!
+
+BUNDLED WITH
+   1.16.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 grdw
+
+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,182 @@
+# Seri
+
+[![CircleCI](https://circleci.com/gh/grdw/serializer.svg?style=svg)](https://circleci.com/gh/grdw/serializer)
+
+A basic replacement for gems like `active_model_serializers`. Can turn any
+basic Ruby object into a Hash or JSON string with features like:
+
+- Aliasing attribute keys
+- Overriding attributes
+- Setting static values
+- Creating conditional attributes
+
+See [usage](#usage) for more details.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'seri'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install seri
+
+## Usage
+
+A serializer can be used as such:
+
+```ruby
+# example class:
+class Car
+  attr_accessor :mileage
+end
+
+# example serializer:
+class CarSerializer < Serializer
+  attribute :mileage
+  attribute :brand
+  attribute :mileage_alias, from: :mileage
+  attribute :honk, static_value: 'honk honk'
+  attribute :some_method
+  attribute :some_conditional_method, condition: :a_condition
+  attribute :some_other_conditional_method, condition: :b_condition
+
+  def some_method
+    object.mileage * 25
+  end
+
+  def brand
+    'mercedes'
+  end
+
+  def some_conditional_method
+    'visible condition'
+  end
+
+  def a_condition
+    true
+  end
+
+  def some_other_conditional_method
+    'non visible condition'
+  end
+
+  def b_condition
+    !a_condition
+  end
+end
+
+# example implementation:
+car = Car.new
+car.mileage = 25
+
+serializer = CarSerializer.new(car)
+serializer.to_json
+```
+
+Result from `#to_json`:
+
+```json
+{
+  "mileage": 25,
+  "brand": "mercedes",
+  "mileage_alias": 25,
+  "honk": "honk_honk",
+  "some_method": "625",
+  "some_conditional_method": "visible_condition"
+}
+```
+
+In turn there's also a `GroupSerializer` available which can take a group of
+cars and turn them into a serialized Array. If we extend the example from
+earlier we can do:
+
+```ruby
+# example:
+cars = [car, car]
+group_serializer = GroupSerializer.new(cars, serializer: CarSerializer)
+
+group_serializer.to_json
+```
+
+Result from `#to_json`:
+
+```json
+[
+  {
+    "mileage": 25,
+    "brand": "mercedes",
+    "mileage_alias": 25,
+    "honk": "honk_honk",
+    "some_method": "625",
+    "some_conditional_method": "visible_condition"
+  },
+  {
+    "mileage": 25,
+    "brand": "mercedes",
+    "mileage_alias": 25,
+    "honk": "honk_honk",
+    "some_method": "625",
+    "some_conditional_method": "visible_condition"
+  }
+]
+```
+
+## Q&A
+
+**Q: This looks cool and all but how do I do a `has_many`?**
+
+Answer:
+
+```ruby
+class A
+  attr_accessor :some_amazing_attribute
+end
+
+class B
+  attr_accessor :some_attribute
+
+  def aaa
+    [A.new, A.new, A.new]
+  end
+end
+
+class ASerializer < Serializer
+  attribute :some_amazing_attribute
+end
+
+class BSerializer < Serializer
+  attribute :lots_of_a, from: :aaa, serializer: ASerializer
+end
+```
+
+The result from `BSerializer.new(b)#to_json`:
+
+```json
+{
+  "lots_of_a": [
+    { "some_amazing_attribute": null },
+    { "some_amazing_attribute": null },
+    { "some_amazing_attribute": null }
+  ]
+}
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/grdw/serializer. 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](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Serializer project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/grdw/seri/blob/master/CODE_OF_CONDUCT.md).

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 "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/lib/serializer/group_serializer.rb

@@ -0,0 +1,20 @@
+class GroupSerializer
+  def initialize(objects, serializer: nil)
+    raise ArgumentError, 'serializer needs to be specified' if serializer.nil?
+
+    @objects = objects
+    @serializer = serializer
+  end
+
+  def to_json(*)
+    Appsignal.instrument(
+      'json.serialize',
+      'Group serializer',
+      @serializer.to_s
+    ) do
+      result = @objects.map { |object| @serializer.new(object).to_h }
+
+      Oj.dump(result, mode: :json)
+    end
+  end
+end

data/lib/serializer/version.rb

@@ -0,0 +1,3 @@
+class Serializer
+  VERSION = "0.1.0"
+end

data/lib/serializer.rb

@@ -0,0 +1,69 @@
+require 'serializer/version'
+require 'serializer/group_serializer'
+
+class Serializer
+  class SerializerError < StandardError; end
+
+  Attribute = Struct.new(:key, :condition, :from, :serializer, :options)
+
+  def self.attributes
+    @attributes ||= []
+  end
+
+  def self.attribute(key, condition: nil, from: nil, serializer: nil, **options)
+    attributes.push(Attribute.new(key, condition, from, serializer, options))
+  end
+
+  attr_accessor :object, :scope
+
+  def initialize(object, scope: {})
+    @object = object
+    @scope = scope
+  end
+
+  # Loops over all attributes and skips if a condition is defined and falsey
+  def to_h
+    self.class.attributes.each_with_object({}) do |attribute, obj|
+      next if attribute.condition && !public_send(attribute.condition)
+
+      extraction_key = attribute.from || attribute.key
+
+      # Fetches a value from an attribute by checking if there's a ..
+      # .. static value set, or a ..
+      # .. method defined in the serializer, or a ..
+      # .. method/attribute defined in the object or ..
+      # .. it raises an error
+      value = if attribute.options.has_key?(:static_value)
+                attribute.options.fetch(:static_value)
+              elsif respond_to?(extraction_key)
+                public_send(extraction_key)
+              elsif object.respond_to?(extraction_key) && attribute.serializer
+                value = object.public_send(extraction_key)
+
+                serialize_value(value, attribute.serializer)
+              elsif object.respond_to?(extraction_key)
+                object.public_send(extraction_key)
+              else
+                raise SerializerError, "unknown attribute '#{extraction_key}'"
+              end
+
+      obj[attribute.key] = value
+    end
+  end
+
+  def to_json(*)
+    Appsignal.instrument('json.serialize', 'Serializer', self.class.to_s) do
+      Oj.dump(to_h, mode: :json)
+    end
+  end
+
+  private
+
+  def serialize_value(value, serializer)
+    if value.is_a?(Array)
+      value.map { |v| serializer.new(v).to_h }
+    else
+      serializer.new(value).to_h
+    end
+  end
+end

data/seri.gemspec

@@ -0,0 +1,32 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "serializer/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "seri"
+  spec.version       = Serializer::VERSION
+  spec.authors       = ["grdw"]
+  spec.email         = ["gerard@wetransfer.com"]
+
+  spec.summary       = %q{A basic serializer}
+  spec.description   = %q{A basic serializer which can suite as a replacement to other gems}
+  spec.homepage      = "https://github.com/grdw/seri"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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_dependency "oj", "~> 3.7"
+  spec.add_dependency "appsignal", "~> 2.7"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: seri
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- grdw
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-11-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: appsignal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A basic serializer which can suite as a replacement to other gems
+email:
+- gerard@wetransfer.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/serializer.rb
+- lib/serializer/group_serializer.rb
+- lib/serializer/version.rb
+- seri.gemspec
+homepage: https://github.com/grdw/seri
+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.7.3
+signing_key: 
+specification_version: 4
+summary: A basic serializer
+test_files: []