simply_serializable 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f0e5cf747f846f0e973a742bad9f9d7a84cf2d38a34934cb0afb699788b5eba0
+  data.tar.gz: d7a352c4f0b1bdc93aa12f95e08c55393c888b686617d6bfa00ac4f5ac17a46f
+SHA512:
+  metadata.gz: 1f4bcc121ae695663a649b7ea4e4494ce558289c3ac247b1c88faa6f8842989454e86056b1c03b1d21a29448ae8a66f65788c0d067e54eac2677438c662f0184
+  data.tar.gz: 594ef6dfa2623ac994286e2888498013d397c2410509c2c523894982a1c0525a07baf8696bdea4b3cdc809b05bfb7e2caf1ef65011e00b2a8d483e4eacd018e1

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 2.3
+before_install:
+  - gem update --system
+  - gem install bundler
+script:
+  - "bundle exec rspec"

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 ryanwjackson@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,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in simply_serializable.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,43 @@
+PATH
+  remote: .
+  specs:
+    simply_serializable (1.0.0)
+      fingerprintable (>= 1.2.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    awesome_print (1.8.0)
+    byebug (11.0.1)
+    colorize (0.8.1)
+    diff-lcs (1.3)
+    fingerprintable (1.2.1)
+      colorize
+    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.3)
+      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
+  awesome_print
+  bundler (~> 2.0)
+  byebug
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  simply_serializable!
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Ryan Jackson
+
+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,66 @@
+# SimplySerializable
+
+SimplySerializable (SS) is a lightweight gem for serializing objects.  It does not follow the JSON API structure, so as to optimizing for cycles and speed.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'simply_serializable'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simply_serializable
+
+## Usage
+
+You can call `SimplySerializable::Serializer` directly or using the mixin on any object like so:
+
+```ruby
+module SimplySerializable
+  class MixinTestObject
+    include SimplySerializable::Mixin
+
+    attr_reader :it_will_use_this_attr
+
+    serialize attributes: %i[foo],
+              except: %i[bar]
+
+    def initialize
+      @it_will_use_this_attr = 'This will be included in serialization.'
+    end
+
+    def bar
+      'This IS NOT included via `except` above.'
+    end
+
+    def foo
+      'This is included via `attributes` above.'
+    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/ryanwjackson/simply_serializable. 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 SimplySerializable project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ryanwjackson/simply_serializable/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 "simply_serializable"
+
+# 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/simply_serializable.rb

@@ -0,0 +1,7 @@
+require 'fingerprintable'
+
+require "simply_serializable/version"
+require "simply_serializable/serializer"
+require "simply_serializable/mixin"
+
+module SimplySerializable; end

data/lib/simply_serializable/debug.rb

@@ -0,0 +1,16 @@
+# TODO: Remove if we don't want this in production?
+def pdb(thing = nil, backtrace_offset: 0, **keywords)
+  backtrace_line = caller[backtrace_offset].split(':')[0..1].join(':')
+  thing = keywords if thing.eql?(nil) && keywords.any?
+  thing = thing.inspect unless thing.is_a?(String)
+
+  puts(
+    (
+      'PDB' + ': ' + thing
+    ).colorize(color: :black, background: :light_white) +
+      " @ #{backtrace_line}".colorize(color: :blue, background: :light_white)
+
+  )
+  puts "\n"
+  thing
+end

data/lib/simply_serializable/mixin.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module SimplySerializable
+  module Mixin
+    module ClassMethods
+      def inherited(subclass)
+        subclass.serializes()
+        super(subclass)
+      end
+
+      def serialize(**config)
+        @serializable_config = config
+      end
+
+      def serializable_config
+        @serializable_config ||= {}
+      end
+    end
+
+    def self.included(base)
+      base.include(Fingerprintable::Mixin)
+      base.extend(ClassMethods)
+    end
+
+    def serialize(cache: {})
+      serializer(cache: cache).serialize
+    end
+
+    def serializer(cache: {})
+      Serializer.new(
+        self.class.serializable_config.merge(
+          cache: cache,
+          object: self
+        )
+      )
+    end
+
+    def serializable_id
+      "#{serializable_type}/#{fingerprint}"
+    end
+
+    def serializable_type
+      self.class.name
+    end
+  end
+end

data/lib/simply_serializable/serializer.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+module SimplySerializable
+  class Serializer
+    attr_reader :attributes,
+                :except,
+                :object,
+                :only
+
+    def initialize(
+      attributes: [],
+      cache: {},
+      except: [],
+      include_readable_instance_variables: true,
+      method_prefix: :serialize,
+      object:,
+      only: []
+    )
+      @object = object
+      @attributes = attributes
+      @include_readable_instance_variables = include_readable_instance_variables
+      @except = except.map(&:to_sym)
+      @only = only.map(&:to_sym)
+      @method_prefix = method_prefix
+      @cache = cache
+      @cache[cache_key] = nil
+      @serialized = false
+
+      populate_attributes
+    end
+
+    def cache
+      serialize unless @serialized
+      @cache
+    end
+
+    def deep_serialize(obj)
+      case obj
+      when FalseClass, Float, nil, Integer, String, Symbol, TrueClass
+        obj
+      when Array
+        obj.map { |v| deep_serialize(v) }
+      when Hash
+        Hash[obj.map { |k, v| [deep_serialize(k), deep_serialize(v)] }]
+      when Module
+        obj.name
+      else
+        serialize_object(obj)
+      end
+    end
+
+    def serialize
+      @serialize ||= begin
+        @serialized = true
+        ret = deep_serialize(object_value_hash)
+
+        cache[cache_key] = ret
+        {
+          root: cache_key,
+          objects: cache
+        }
+      end
+    end
+
+    def to_s
+      @to_s ||= serialize.to_s
+    end
+
+    private
+
+    def instance_vars_with_readers
+      instance_variables = Hash[object.instance_variables.map { |e| [e, 1] }]
+      ret = object.class.instance_methods.select do |method|
+        instance_variables.key?("@#{method}".to_sym)
+      end
+      ret.map(&:to_sym)
+    end
+
+    def serialize_object(use_object)
+      use_object_cache_key = cache_key(use_object)
+      return use_object_cache_key if cache.key?(use_object_cache_key)
+      raise "#{use_object.class.name} does not respond to serialize.  Did you mean to include Serializable in this class?" unless use_object.respond_to?(:serialize)
+
+      serializer = use_object.serializer(cache: cache)
+      cache.merge!(serializer.cache)
+      use_object_cache_key
+    end
+
+    def cache_key(obj = object)
+      obj.serializable_id
+    end
+
+    def populate_attributes
+      raise 'You cannot pass only and except values.  Please choose one.' if only.any? && except.any?
+
+      @attributes |= instance_vars_with_readers if @include_readable_instance_variables
+
+      @attributes = attributes & only if only.any?
+      @attributes = attributes - except if except.any?
+      attributes
+    end
+
+    def method_for_attribute(attr)
+      if object.class.instance_methods.include?("#{@method_prefix}_#{attr}".to_sym)
+        "#{@method_prefix}_#{attr}"
+      else
+        attr
+      end
+    end
+
+    def object_value_hash
+      Hash[attributes.map do |attr|
+        [attr, object.send(method_for_attribute(attr))]
+      end]
+    end
+  end
+end

data/lib/simply_serializable/version.rb

@@ -0,0 +1,3 @@
+module SimplySerializable
+  VERSION = "1.0.0"
+end

data/release.sh

@@ -0,0 +1,8 @@
+#!/bin/bash
+
+if output=$(git status --porcelain) && [ -z "$output" ]; then
+  bump $1 && git push && bundle exec rake build && bundle exec rake release
+else
+  echo 'PLEASE COMMIT ALL CHANGES BEFORE RELEASING.'
+  exit 1
+fi

data/simply_serializable.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simply_serializable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'simply_serializable'
+  spec.version       = SimplySerializable::VERSION
+  spec.authors       = ['Ryan Jackson']
+  spec.email         = ['ryanwjackson@gmail.com']
+
+  spec.summary       = 'Simply Serializable makes it easy to serialize any object.'
+  spec.description   = 'Simply Serializable makes it easy to serialize any object.  It provides a configuratable way to serialize the attributes you want and ignore the ones you don\'t.'
+  spec.homepage      = 'https://www.github.com/ryanwjackson/simply_serializable'
+  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(__dir__)) 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 'fingerprintable', '>= 1.2.1'
+  spec.add_development_dependency 'awesome_print'
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'byebug', '>= 0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: simply_serializable
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ryan Jackson
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-06-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fingerprintable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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: 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: Simply Serializable makes it easy to serialize any object.  It provides
+  a configuratable way to serialize the attributes you want and ignore the ones you
+  don't.
+email:
+- ryanwjackson@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".byebug_history"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/simply_serializable.rb
+- lib/simply_serializable/debug.rb
+- lib/simply_serializable/mixin.rb
+- lib/simply_serializable/serializer.rb
+- lib/simply_serializable/version.rb
+- release.sh
+- simply_serializable.gemspec
+homepage: https://www.github.com/ryanwjackson/simply_serializable
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Simply Serializable makes it easy to serialize any object.
+test_files: []