serialized-hashie 0.0.0.dev

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b305ccfa0e54e4a808259f967ed9d4ebc7cc95b7fa52b8930196ae97d6db5a39
+  data.tar.gz: 77edb806bc4dd9f7b425ddacc4c566925debc1d5e5fd02add53b7b883fcccf4d
+SHA512:
+  metadata.gz: b417aa6c94e37ca8eb989faf359ffea46d145f66174f9560a7e4ecd1b4f02909bc86190c79da913c76e388c63971dbe0a24f68db9b2c204ad846cf593c6f49ab
+  data.tar.gz: 6c486630d660930d70e7bfd740d53013c7c35ea4d683309e4d7277fd30efd76b5b24ca4f34fb2367a91f0b8b8e4455733aa91e23290b4b9e1144e77a23caf43f

data/.github/workflows/ci.yml

@@ -0,0 +1,21 @@
+name: CI
+on: [push]
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby_version:
+          - 2.5
+          - 2.6
+          - 2.7
+    steps:
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby_version }}
+      - uses: actions/checkout@v2
+      - name: Install dependencies
+        run: bundle install && bundle exec appraisal install
+      - name: Run tests
+        run: bundle exec appraisal rspec

data/.github/workflows/package.yml

@@ -0,0 +1,43 @@
+name: Build Package
+
+on:
+  push:
+    tags:
+      - "*"
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@master
+      - name: Set up Ruby 2.6
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: 2.6.x
+
+      - name: Build Gem
+        run: gem build *.gemspec
+
+      - name: Export version from tag name
+        run: echo "${GITHUB_REF/refs\/tags\//}" > VERSION
+
+      - name: Setup credentials
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:rubygems_api_key: ${RUBYGEMS_API_KEY}\n" > $HOME/.gem/credentials
+          printf -- ":github: Bearer ${GITHUB_API_KEY}\n" >> $HOME/.gem/credentials
+        env:
+          RUBYGEMS_API_KEY: ${{secrets.KRYSTAL_RUBYGEMS_API_KEY}}
+          GITHUB_API_KEY: ${{secrets.GITHUB_TOKEN}}
+
+      - name: Publish to RubyGems
+        run: |
+          gem push *.gem
+
+      - name: Publish to GPR
+        run: |
+          gem push --key github --host https://rubygems.pkg.github.com/krystal *.gem

data/.gitignore

@@ -0,0 +1,17 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# Appraisals generated Gemfiles
+/gemfiles/
+
+# rspec failure tracking
+.rspec_status
+.rubocop-http*
+VERSION

data/.rubocop.yml

@@ -0,0 +1,2 @@
+inherit_from:
+  - https://dev.k.io/rubocop/rubocop.yml

data/Appraisals

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+appraise 'json-1.8' do
+  gem 'json', '~> 1.8.0'
+end
+
+appraise 'json-2' do
+  gem 'json', '~> 2.0'
+end

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in serialized_hashie.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+gem 'rubocop'

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2020 Krystal Hosting Ltd
+
+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,54 @@
+# Serialized Hashie
+
+This is a library that allows you to serialize a Hashie::Mash object (as JSON) into a database. It also features a couple of extra extensions to allow you to alter how objects are serialized/deserialized.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+source 'https://rubygems.pkg.github.com/krystal' do
+  gem 'serialized-hashie', '~> 1.0'
+end
+```
+
+## Usage
+
+This is designed to be used a serializer for ActiveRecord models.
+
+```ruby
+class User < ApplicationRecord
+  serialize :properties, SerializedHashie::Hash
+end
+
+user = User.new
+user.properties.something = 'Hello world!'
+user.save
+
+user = User.last
+user.properties.something #=> 'Hello world!'
+```
+
+### Extensions
+
+The loading & dumping can also be extended to handle how individual entries in any hashes are handled.
+
+```ruby
+# Add an extension to dump all stings in uppercase
+SerializedHashie.dump_extensions.add(:upcase) do |value|
+  value.is_a?(String) ? value.upcase : value
+end
+
+# Add a load extension to always return them again in lowercase
+SerializedHashie.load_extensions.add(:downcase) do |value|
+  value.is_a?(String) ? value.downcase : value
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rspec` 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/krystal/serialized-hashie.

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "serialized_hashie"
+
+# 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/serialized_hashie.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'serialized_hashie/version'
+require 'serialized_hashie/hash'
+require 'serialized_hashie/extensions'
+
+module SerializedHashie
+
+  class Error < StandardError
+  end
+
+  class << self
+
+    def load_extensions
+      @load_extensions ||= Extensions.new
+    end
+
+    def dump_extensions
+      @dump_extensions ||= Extensions.new
+    end
+
+  end
+
+end

data/lib/serialized_hashie/extensions.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module SerializedHashie
+  class Extensions
+
+    def initialize
+      reset
+    end
+
+    def reset
+      @extensions = {}
+    end
+
+    def add(name, &block)
+      if has?(name)
+        raise Error, "Extension already defined named '#{name}'"
+      end
+
+      @extensions[name.to_sym] = block
+    end
+
+    def has?(name)
+      @extensions.key?(name.to_sym)
+    end
+
+    def run(value)
+      @extensions.each_value do |block|
+        value = block.call(value)
+      end
+      value
+    end
+
+  end
+end

data/lib/serialized_hashie/hash.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require 'serialized_hashie'
+require 'hashie/mash'
+require 'json'
+
+module SerializedHashie
+  class Hash < Hashie::Mash
+
+    class << self
+
+      def dump(obj)
+        hash = dump_hash(obj)
+        hash.to_json
+      end
+
+      def load(raw_hash)
+        hash = JSON.parse(presence(raw_hash) || '{}')
+        hash = load_hash(hash)
+        new(hash)
+      end
+
+      private
+
+      def blank?(value)
+        return true if value.nil?
+        return true if value.is_a?(String) && value.empty?
+
+        false
+      end
+
+      def presence(value)
+        blank?(value) ? nil : value
+      end
+
+      def dump_hash(hash)
+        hash = hash.transform_values do |value|
+          dump_value(value)
+        end
+        hash.reject { |_, v| blank?(v) }
+      end
+
+      def dump_value(value)
+        if blank?(value)
+          return nil
+        end
+
+        if value.is_a?(::Hash)
+          return dump_hash(value)
+        end
+
+        if value.is_a?(::Array)
+          return value.map { |v| dump_value(v) }.compact
+        end
+
+        SerializedHashie.dump_extensions.run(value)
+      end
+
+      def load_hash(hash)
+        hash.transform_values do |value|
+          load_value(value)
+        end
+      end
+
+      def load_value(value)
+        return load_hash(value) if value.is_a?(::Hash)
+        return value.map { |v| load_value(v) } if value.is_a?(Array)
+
+        SerializedHashie.load_extensions.run(value)
+      end
+
+    end
+
+  end
+end

data/lib/serialized_hashie/version.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module SerializedHashie
+
+  VERSION_FILE_ROOT = File.expand_path('../../VERSION', __dir__)
+  if File.file?(VERSION_FILE_ROOT)
+    VERSION = File.read(VERSION_FILE_ROOT).strip.delete_prefix('v')
+  else
+    VERSION = '0.0.0.dev'
+  end
+
+end

data/serialized-hashie.gemspec

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative 'lib/serialized_hashie/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'serialized-hashie'
+  spec.version       = SerializedHashie::VERSION
+  spec.authors       = ['Adam Cooke']
+  spec.email         = ['adam@krystal.uk']
+  spec.summary       = 'Helpers to serialize data into ActiveRecord models as JSON and returning a Hashie::Mash'
+  spec.description   = spec.summary
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+  spec.licenses = ['MIT']
+  spec.homepage = 'https://github.com/krystal/serialized-hashie'
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(/^(test|spec|features)\//) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(/^exe\//) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'appraisal', '~> 2.3'
+
+  spec.add_runtime_dependency 'hashie', '>= 4.0', '< 5.0'
+  spec.add_runtime_dependency 'json', '>= 1.8', '< 3.0'
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: serialized-hashie
+version: !ruby/object:Gem::Version
+  version: 0.0.0.dev
+platform: ruby
+authors:
+- Adam Cooke
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-08-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Helpers to serialize data into ActiveRecord models as JSON and returning
+  a Hashie::Mash
+email:
+- adam@krystal.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ci.yml"
+- ".github/workflows/package.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- Appraisals
+- Gemfile
+- MIT-LICENSE
+- README.md
+- bin/console
+- bin/setup
+- lib/serialized_hashie.rb
+- lib/serialized_hashie/extensions.rb
+- lib/serialized_hashie/hash.rb
+- lib/serialized_hashie/version.rb
+- serialized-hashie.gemspec
+homepage: https://github.com/krystal/serialized-hashie
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Helpers to serialize data into ActiveRecord models as JSON and returning
+  a Hashie::Mash
+test_files: []