primalize 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f9454407dd6619d27027fc4a5ef40252868dc8ae
+  data.tar.gz: e841a6d57e23800b2fc273141e58ededbe969205
+SHA512:
+  metadata.gz: 2574db91856d1145c4738ab69831a4862227908f857e78668970c5dd59efe6397a06f79a4d033b2f5a885961fdccbf7afeac4f8334c381524a6dbebe6d320e96
+  data.tar.gz: 7eb666e43e360456289f70537262c1134d966fe47bb9eb89e4cd4d1399a777277957df148182f84cb2724bdfcdb884d1b65794c384a7c11f3cb07ed564632152

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.4.1
+before_install: gem install bundler -v 1.16.0.pre.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 jgaskins@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,6 @@
+source "https://rubygems.org"
+
+# git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in primalize.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,43 @@
+PATH
+  remote: .
+  specs:
+    primalize (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    method_source (0.8.2)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (10.5.0)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+    slop (3.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16.a)
+  primalize!
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.0.pre.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Jamie Gaskins
+
+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,131 @@
+# Primalize
+
+Primalize lets you de-evolve your objects into primitive values for serialization. The primary use case is to serialize them into JSON, but once it's in its primitive state, it can be converted into other formats such as XML or CSV.
+
+Primalizers support type checking by letting you specify the types of the resulting properties:
+
+```ruby
+class OrderSerializer < Primalize::Single
+  attributes(
+    id: integer,
+    customer_id: integer,
+    product_ids: array(integer),
+    status: enum(
+      'requested',
+      'payment_processed',
+      'awaiting_shipment',
+      'shipped',
+      'delivered',
+    ),
+    signature_required: boolean,
+    shipping_address: object(
+      address1: string,
+      address2: optional(string),
+      city: string,
+      state: string,
+      zip: string,
+    ),
+    created_at: timestamp,
+  )
+end
+
+OrderSerializer.new(order).call
+# { id: ... }
+```
+
+You can also primalize a nested structure of response objects with `Primalize::Many`, replacing the type annotations with the classes of their respective serializers:
+
+```ruby
+class PostResponseSerializer < Primalize::Many
+  attributes(
+    post: PostSerializer,
+    author: UserSerializer,
+    comments: enumerable(CommentSerializer), # Not just one comment, but *many*
+  )
+end
+
+# Instantiate it by passing in the pertinent values
+serializer = PostResponseSerializer.new(
+  post: @post,
+  author: @post.author,
+  comments: @post.comments,
+)
+
+serializer.call
+# {
+#   post: { ... },
+#   author: { ... },
+#   comments: [
+#     { ... },
+#   ],
+# }
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'primalize'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install primalize
+
+## Usage
+
+If you need to primalize a single object, you subclass `Primalize::Single` and specify the attributes and types of the result as in the example above. But reducing the object's attributes to a hash isn't all you do in most apps. You may also need to do some coercion. For example, if you have an object whose `city` isn't stored as a string but you need to translate it to one:
+
+```ruby
+class ShipmentSerializer < Primalize::Single
+  attributes(
+    city: string { |city| city.name },
+    # ...
+  )
+end
+```
+
+You can also generate attributes that don't exist on the object being primalized by defining methods on the primalizer:
+
+```ruby
+class ShipmentSerializer < Primalize::Single
+  attributes(
+    payment_method: string,
+  )
+
+  def payment_method
+    if object.paid_with_card?
+      'credit_card'
+    elsif object.purchase_order?
+      'purchase_order'
+    elsif object.bill_later?
+      'invoice'
+    else
+      'unknown'
+    end
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jgaskins/primalize. 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 Primalize project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/jgaskins/primalize/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,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "primalize"
+require "pry"
+
+Pry.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/primalize.rb

@@ -0,0 +1,3 @@
+require 'primalize/version'
+require 'primalize/single'
+require 'primalize/many'

data/lib/primalize/many.rb

@@ -0,0 +1,90 @@
+module Primalize
+  class Many
+    def self.attributes attrs={}
+      @attributes ||= {}
+      add_attributes attrs
+
+      @attributes
+    end
+
+    def self.add_attributes attrs
+      return if attrs.none?
+
+      attrs.each do |attr, serializer_class|
+        if serializer_class.nil?
+          raise TypeError, "Serializer for #{self}##{attr} cannot be nil"
+        end
+      end
+
+      @attributes.merge! attrs
+    end
+
+    def self.enumerable serializer_class
+      Class.new(Enumerable) do
+        define_method :call do
+          @enumerable.map { |item| serializer_class.new(item).call }
+        end
+
+        define_singleton_method :inspect do
+          "enumerable(#{serializer_class.inspect})"
+        end
+      end
+    end
+
+    class Enumerable
+      def initialize enumerable
+        validate! enumerable
+
+        @enumerable = enumerable
+      end
+
+      def validate! enumerable
+        unless %w(each map).all? { |msg| enumerable.respond_to? msg }
+          raise ArgumentError, "#{self.class.inspect} must receive an Enumerable object, received #{enumerable.inspect}"
+        end
+      end
+
+      def call
+        raise RuntimeError,
+          "Called #{inspect}#call. Please use Primalize::Many.enumerable to create primalizers for this."
+      end
+    end
+
+    def self.inspect
+      attrs = attributes
+        .map { |attr, serializer| "#{attr}: #{serializer.inspect}" }
+        .join(', ')
+
+      "#{name}(#{attrs})"
+    end
+
+    def initialize attributes
+      validate_attributes! attributes
+
+      @attributes = attributes
+    end
+
+    def validate_attributes! attributes
+      unless self.class.attributes.each_key.all? { |key| attributes[key] }
+        non_nil_keys = attributes
+          .select { |_attr, value| value }
+          .map { |attr, _value| attr }
+
+        missing_keys = self.class.attributes.keys - non_nil_keys
+
+        raise ArgumentError,
+          "#{self.class} is missing the following keys: #{missing_keys.map(&:inspect).join(', ')}"
+      end
+    end
+
+    def call
+      self.class.attributes.each_with_object({}) do |(attr, serializer_class), hash|
+        hash[attr] = serializer_class.new(@attributes.fetch(attr)).call
+      end
+    end
+
+    def to_json
+      call.to_json
+    end
+  end
+end

data/lib/primalize/single.rb

@@ -0,0 +1,253 @@
+require 'json'
+require 'date'
+
+module Primalize
+  class Single
+    @type_mismatch_handler = proc do |attr, type, value|
+      raise TypeError, "#{self}##{attr} is specified as #{type.inspect}, but is #{value.inspect}"
+    end
+
+    class << self
+
+      def attributes attrs={}
+        @attributes ||= {}
+
+        add_attributes attrs
+
+        @attributes
+      end
+
+      def add_attributes attrs
+        return if attrs.none?
+
+        @attributes.merge! attrs
+
+        attrs.each do |attr, type|
+          define_method attr do
+            value = type.coerce(object.public_send(attr))
+            if type === value
+              value
+            else
+              self.class.type_mismatch_handler.call attr, type, value
+            end
+          end
+        end
+      end
+
+      def integer &coerce
+        Integer.new(&coerce)
+      end
+
+      def string &coerce
+        String.new(&coerce)
+      end
+
+      def boolean &coerce
+        enum(true, false, &coerce)
+      end
+
+      def array *types, &coerce
+        Array.new(types, &coerce)
+      end
+
+      def object **types, &coerce
+        Object.new(types, &coerce)
+      end
+
+      def float &coerce
+        Float.new(&coerce)
+      end
+
+      def optional *types, &coerce
+        Optional.new(types, &coerce)
+      end
+
+      def enum *values, &coerce
+        Enum.new(values, &coerce)
+      end
+
+      def timestamp &coerce
+        Timestamp.new(&coerce)
+      end
+
+      def type_mismatch_handler= handler
+        @type_mismatch_handler = handler
+      end
+
+      def type_mismatch_handler
+        if @type_mismatch_handler
+          @type_mismatch_handler
+        else
+          superclass.type_mismatch_handler
+        end
+      end
+
+      def inspect
+        "#{name}(#{attributes.map { |attr, type| "#{attr}: #{type.inspect}" }.join(', ') })"
+      end
+    end
+
+    attr_reader :object
+
+    def initialize object
+      @object = object
+    end
+
+    def call
+      self.class.attributes.each_with_object({}) do |(attr, _), hash|
+        hash[attr] = public_send(attr)
+      end
+    end
+
+    # TYPES
+
+    DEFAULT_COERCION = proc { |arg| arg } # Don't coerce by default
+
+    module Type
+      def coerce *args
+        (@coercion || DEFAULT_COERCION).call(*args)
+      end
+    end
+
+    class Integer
+      include Type
+
+      def initialize &coercion
+        @coercion = coercion
+      end
+
+      def === value
+        ::Integer === value
+      end
+
+      def inspect
+        'integer'
+      end
+    end
+
+    class Float
+      include Type
+
+      def initialize &coercion
+        @coercion = coercion
+      end
+
+      def === value
+        ::Float === value
+      end
+
+      def inspect
+        'float'
+      end
+    end
+
+    class String
+      include Type
+
+      def initialize &coercion
+        @coercion = coercion
+      end
+
+      def === value
+        ::String === value
+      end
+
+      def inspect
+        'string'
+      end
+    end
+
+    class Array
+      include Type
+
+      def initialize types, &coercion
+        @types = types
+        @coercion = coercion
+      end
+
+      def === value
+        return false unless ::Array === value
+        value.all? do |item|
+          @types.any? { |type| type === item }
+        end
+      end
+
+      def inspect
+        "array(#{@types.map(&:inspect).join(', ')})"
+      end
+    end
+
+    class Enum
+      include Type
+
+      def initialize values, &coercion
+        @values = values
+        @coercion = coercion
+      end
+
+      def === value
+        @values.include? value
+      end
+
+      def coerce value
+        super value, @values
+      end
+
+      def inspect
+        "enum(#{@values.map(&:inspect).join(', ')})"
+      end
+    end
+
+    class Object
+      include Type
+
+      def initialize types, &coercion
+        @types = types
+        @coercion = coercion || DEFAULT_COERCION
+      end
+
+      def === value
+        return false unless ::Hash === value
+
+        @types.all? do |attr, type|
+          type === value[attr]
+        end
+      end
+
+      def inspect
+        "object(#{@types.map { |attr, type| "#{attr}: #{type.inspect}" }.join(', ')})"
+      end
+    end
+
+    class Timestamp
+      include Type
+
+      TYPES = [Time, Date, DateTime].freeze
+
+      def === value
+        TYPES.any? { |type| type === value }
+      end
+
+      def inspect
+        'timestamp'
+      end
+    end
+
+    class Optional
+      include Type
+
+      def initialize types, &coercion
+        @types = types
+        @coercion = coercion
+      end
+
+      def === value
+        value.nil? || @types.any? { |type| type === value }
+      end
+
+      def inspect
+        "optional(#{@types.map(&:inspect).join(', ')})"
+      end
+    end
+  end
+end

data/lib/primalize/version.rb

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

data/primalize.gemspec

@@ -0,0 +1,27 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "primalize/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "primalize"
+  spec.version       = Primalize::VERSION
+  spec.authors       = ["Jamie Gaskins"]
+  spec.email         = ["jgaskins@gmail.com"]
+
+  spec.summary       = %q{Type-checked serializers for your Ruby objects}
+  spec.homepage      = "https://github.com/jgaskins/primalize"
+  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.16.a"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: primalize
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jamie Gaskins
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-09-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.16.a
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.16.a
+- !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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: 
+email:
+- jgaskins@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/primalize.rb
+- lib/primalize/many.rb
+- lib/primalize/single.rb
+- lib/primalize/version.rb
+- primalize.gemspec
+homepage: https://github.com/jgaskins/primalize
+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: Type-checked serializers for your Ruby objects
+test_files: []