cereals 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e8cbb295200da71a6eb80a440f3f7cfe77ca4545
+  data.tar.gz: 48dcbbd6c495b0da2a407134a54d1a242a264610
+SHA512:
+  metadata.gz: d1809ee98e931cf46ed8078d6b84f4a416085e64796deab40e91ac2fd3687db6188249f5971a35bbbb1a401368107945b652d82c1d10be32d85d9bd4936c0cab
+  data.tar.gz: a8d8e67a763f0a74e5ec544da1ab1c5e5f7b91719decd26ea07029ee03f48a3cbf6aa36503003b24f79636e9c7bb2bc441b8752f8a74309e75a8c8e0b2604dd0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Tee Parham, Michael Guida
+
+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,138 @@
+# Cereals
+
+Cereals makes it easy to serialize ruby objects to JSON.
+Cereals provides serializer classes for single objects and collections.
+
+Cereals depends on ActiveSupport's `#to_json` and `#to_hash` implementations.
+
+## Install
+
+Add the gem to your Gemfile:
+
+```ruby
+gem "cereals"
+```
+
+## Usage
+
+Include the `Cereals::Base` module in the classes you want to serialize.
+If you're using Rails 5+, add it to `ApplicationRecord` like so:
+
+```ruby
+class ApplicationRecord
+  include Cereals::Base
+end
+```
+
+Create serializer classes with names corresponding to your models.
+Implement `#to_hash` on each serializer.
+
+```ruby
+class UserSerializer < Cereals::Serializer
+  def to_hash
+    {
+      first_name: @object.first_name,
+      last_name: @object.last_name
+    }
+end
+```
+
+A JSON API might look like this:
+
+```ruby
+class UsersController
+  def show
+    user = User.find(params[:id])
+    render json: user.to_json
+  end
+
+  def index
+    users = User.all
+    render json: ArraySerializer.new(users, "users").to_json
+  end
+end
+```
+
+## JSON Format
+
+Single objects have a root node.
+
+`UserSerializer.new(user).to_json`
+
+```
+{
+  "user": {
+    "first_name":"Bart",
+    "last_name":"Simpson"
+  }
+}
+```
+
+Arrays have a root node, and items within the array do not.
+
+`ArraySerializer.new([user1, user2]).to_json`
+
+```
+{
+  "users": [
+    {
+      "first_name":"Bart",
+      "last_name":"Simpson"
+    },
+    {
+      "first_name":"Lisa",
+      "last_name":"Simpson"
+    }    
+  ]
+}
+```
+
+## Configuration
+
+Specify a different serializer class for a model:
+
+```ruby
+class User
+  def serializer_class
+    PersonSerializer
+  end
+end
+```
+
+Specify a different root name for a serializer:
+
+```ruby
+class UserSerializer
+  private
+
+  def root_name
+    "person"
+  end
+end
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+Run `rake test` to run the tests. You can also run `bin/console` for an
+interactive REPL.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/teeparham/cereals.
+
+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).
+
+## Code of Conduct
+
+Everyone interacting in the Cereals project’s codebases, issue trackers, chat rooms and
+mailing lists is expected to follow the
+[code of conduct](https://github.com/teeparham/cereals/blob/master/CODE_OF_CONDUCT.md).

data/lib/cereals/array_serializer.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Cereals
+  class ArraySerializer
+    # objects must respond to :serializer
+    # root is a string, the name of the root JSON key
+    def initialize(objects, root)
+      @objects = objects
+      @root = root
+    end
+
+    def to_json
+      { @root => wrap_objects.as_json(root: false) }.to_json
+    end
+
+    private
+
+    def wrap_objects
+      @objects.map(&:serializer)
+    end
+  end
+end

data/lib/cereals/base.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Cereals
+  module Base
+    def self.included(base)
+      base.delegate :to_json, to: :serializer
+    end
+
+    def serializer_class
+      Object.const_get("#{self.class.name}Serializer")
+    end
+
+    def serializer
+      serializer_class.new(self)
+    end
+  end
+end

data/lib/cereals/serializer.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Cereals
+  class Serializer
+    def initialize(object)
+      @object = object
+    end
+
+    # see lib/active_support/core_ext/object/json.rb
+    # for the definitions of #to_json and #as_json added by ActiveSupport
+
+    # super is ActiveSupport::ToJsonWithActiveSupportEncoder
+    def to_json(root: true)
+      super(root: root)
+    end
+
+    # override ActiveSupport's #as_json
+    def as_json(root: true)
+      if root
+        { root_name => to_hash }
+      else
+        to_hash
+      end
+    end
+
+    private
+
+    def root_name
+      @object.class.name.underscore
+    end
+  end
+end

data/lib/cereals/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Cereals
+  VERSION = "0.0.0"
+end

data/lib/cereals.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require "cereals/version"
+require "cereals/array_serializer"
+require "cereals/base"
+require "cereals/serializer"
+require "active_support/all"

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: cereals
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Tee Parham
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-05-26 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.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.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'
+description: JSON serializer classes
+email:
+- tee@neighborland.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/cereals.rb
+- lib/cereals/array_serializer.rb
+- lib/cereals/base.rb
+- lib/cereals/serializer.rb
+- lib/cereals/version.rb
+homepage: https://github.com/teeparham/cereals
+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.12
+signing_key: 
+specification_version: 4
+summary: JSON serializer classes
+test_files: []
+has_rdoc: