dry_serialization 0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fffe54a30bc7e0e3dcffda5ffd92c83362d98493bcd7d48e766867468f1a3cca
+  data.tar.gz: 9143b1bca8c2f5738f7bc9c3ad142f883405c69518c4cb8c17f89006e045fb8f
+SHA512:
+  metadata.gz: f00eaa9aa4055e0de5e20eaceda000b8509dc1ee53b5032251be9c2691f988c36b39ef9a7ea51c56668339612bb054125bf053907d78fb727fcea08700ee3fd1
+  data.tar.gz: 5415bcd22ad6007f85b868da92dd5ae681884761dcc60f13c3758d4d80241d8806ced854dacd48e66591fe8f907e03687eb2ef5ed98a001c62b9ccaf90ddd330

data/README.md

@@ -0,0 +1,51 @@
+# DrySerialization
+
+![AppVeyor](https://img.shields.io/appveyor/build/mikeyduece/dry_serialization?style=plastic)
+![Code Climate maintainability](https://img.shields.io/codeclimate/maintainability/mikeyduece/dry_serialization?style=plastic)
+![GitHub issues](https://img.shields.io/github/issues-raw/mikeyduece/dry_serialization?style=plastic)
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/dry_serialization`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dry_serialization'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install dry_serialization
+
+## Usage
+
+- Install with rails generator
+  * currently supported serializers are `:blueprinter`
+  
+
+    `rails g dry_serialization:<serializer_name>:install`
+    
+
+    
+    
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/mikeyduece/dry_serialization.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/dry_serialization.gemspec

@@ -0,0 +1,34 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dry_serialization/version'
+require 'dry_serialization'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'dry_serialization'
+  spec.version       = DrySerialization::VERSION
+  spec.authors       = ['Mike Heft']
+  spec.email         = ['mikeheft@gmail.com']
+
+  spec.summary       = %q{Drys up serialized returns by passing in object, serializer, and an options hash}
+  #spec.description   = %q{TODO: Write a longer description or delete this line.}
+  #spec.homepage      = 'TODO: Put your gem's website or public repo URL here.'
+  spec.license       = 'MIT'
+
+  spec.files = Dir['lib/**/*', 'CHANGELOG.md', 'MIT-LICENSE', 'Rakefile', 'README.md', 'dry_serialization.gemspec']
+  
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'rspec', '~> 3.7'
+  spec.add_development_dependency 'factory_bot'
+  spec.add_development_dependency 'generator_spec'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'activerecord'
+  spec.add_development_dependency 'sqlite3', '~> 1.4'
+  spec.add_development_dependency 'yard', '~> 0.9.11'
+  spec.add_development_dependency 'fast_jsonapi'
+end

data/lib/dry_serialization.rb

@@ -0,0 +1,7 @@
+require "dry_serialization/version"
+require "dry_serialization/blueprinter"
+require "dry_serialization/fast_jsonapi"
+
+module DrySerialization
+  
+end

data/lib/dry_serialization/blueprinter.rb

@@ -0,0 +1,7 @@
+module DrySerialization::Blueprinter
+
+  def serialized_resource(resource, blueprint, options = {})
+    JSON.parse(blueprint.render(resource, options), symbolize_names: true)
+  end
+  
+end

data/lib/dry_serialization/fast_jsonapi.rb

@@ -0,0 +1,12 @@
+module DrySerialization::FastJsonapi
+  
+  def serialized_resource(resource, serializer, options = {})
+    if resource.is_a?(ActiveRecord::Relation) || resource.is_a?(Array)
+      options[:is_collection] = true
+    else
+      options[:is_collection] = false
+    end
+    
+    serializer.new(resource, options)
+  end
+end

data/lib/dry_serialization/version.rb

@@ -0,0 +1,3 @@
+module DrySerialization
+  VERSION = "0.3"
+end

data/lib/generators/base_generator.rb

@@ -0,0 +1,53 @@
+require 'rails/generators/base'
+
+class BaseGenerator < Rails::Generators::Base
+  API_CONTROLLER_PATH = 'app/controllers/api_controller.rb'.freeze
+  SERIALIZERS = {
+    ams: 'ActiveModelSerializers',
+    blueprinter: 'Blueprinter',
+    fast_jsonapi: 'FastJsonapi'
+  }
+  
+  def self.exit_on_failure?
+    true
+  end
+  
+  private
+  
+  # Removes other serialization gems, currently just AMS and FastJsonapi
+  def remove_other_supported_gems(*gems)
+    gems = [gems] unless gems.is_a?(Array)
+    return if gems.empty?
+    
+    gems.each do |gem|
+      log_statement(gem, :yellow)
+      gsub_file('Gemfile', /^(\ngem #{gem.underscore})/, '')
+    end
+  
+  end
+  
+  # Adds an ApiController if one does not exist to ensure proper encapsulation,
+  # especially if in a Rails monolith with Rails HTML views as well
+  def copy_api_controller
+    puts set_color('Checking if an ApiController exists...', :cyan)
+    
+    unless File.exists?('app/controllers/api_controller.rb')
+      puts set_color('ApiController not present, creating ApiController...', :cyan)
+      template 'api_controller.rb', API_CONTROLLER_PATH
+    end
+  end
+  
+  def helper_include(serializer)
+    copy_api_controller
+    gsub_file(API_CONTROLLER_PATH, /^*(include DrySerialization::.*)\n/, '')
+    puts 'Adding include statement to ApiController'
+    insert_into_file(API_CONTROLLER_PATH,
+                     "\n\tinclude DrySerialization::#{serializer}",
+                     after: 'class ApiController < ActionController::API'
+    )
+  end
+  
+  def log_statement(serializer, color = :green)
+    puts set_color("Removed #{serializer}", color)
+  end
+end

data/lib/generators/dry_serialization/blueprinter/install_generator.rb

@@ -0,0 +1,23 @@
+require 'generators/base_generator'
+
+module DrySerialization
+  module Blueprinter
+    class InstallGenerator < BaseGenerator
+      source_root File.expand_path("../../../templates", __FILE__)
+      
+      # Add blueprinter gem to gemfile after dry_serialization declaration and bundles the newly declared gem
+      def install_blueprinter
+        remove_other_supported_gems(SERIALIZERS[:ams], SERIALIZERS[:fast_jsonapi])
+        
+        puts "Installing #{SERIALIZERS[:blueprinter]}..."
+        insert_into_file('Gemfile',
+                         "\ngem 'blueprinter'",
+                         after: "gem 'dry_serialization', source: 'https://gem.fury.io/mikeyduece-gems/'")
+        run 'bundle install'
+        
+        helper_include(SERIALIZERS[:blueprinter])
+      end
+    
+    end
+  end
+end

data/lib/generators/dry_serialization/fast_jsonapi/install_generator.rb

@@ -0,0 +1,23 @@
+require 'generators/base_generator'
+
+module DrySerialization
+  module FastJsonapi
+    class InstallGenerator < BaseGenerator
+      source_root File.expand_path("../../../templates", __FILE__)
+      
+      # Add blueprinter gem to gemfile after dry_serialization declaration and bundles the newly declared gem
+      def install_blueprinter
+        remove_other_supported_gems(SERIALIZERS[:blueprinter], SERIALIZERS[:ams])
+        
+        puts "Installing #{SERIALIZERS[:blueprinter]}..."
+        insert_into_file('Gemfile',
+                         "\ngem 'fast_jsonapi'",
+                         after: "gem 'dry_serialization', source: 'https://gem.fury.io/mikeyduece-gems/'")
+        run 'bundle install'
+        
+        helper_include(SERIALIZERS[:fast_jsonapi])
+      end
+    
+    end
+  end
+end

data/lib/generators/templates/api_controller.rb

@@ -0,0 +1,3 @@
+class ApiController < ActionController::API
+
+end

metadata

@@ -0,0 +1,195 @@
+--- !ruby/object:Gem::Specification
+name: dry_serialization
+version: !ruby/object:Gem::Version
+  version: '0.3'
+platform: ruby
+authors:
+- Mike Heft
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-06-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.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  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: generator_spec
+  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: 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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: activerecord
+  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: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.11
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.11
+- !ruby/object:Gem::Dependency
+  name: fast_jsonapi
+  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:
+- mikeheft@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- dry_serialization.gemspec
+- lib/dry_serialization.rb
+- lib/dry_serialization/blueprinter.rb
+- lib/dry_serialization/fast_jsonapi.rb
+- lib/dry_serialization/version.rb
+- lib/generators/base_generator.rb
+- lib/generators/dry_serialization/blueprinter/install_generator.rb
+- lib/generators/dry_serialization/fast_jsonapi/install_generator.rb
+- lib/generators/templates/api_controller.rb
+homepage: 
+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.8
+signing_key: 
+specification_version: 4
+summary: Drys up serialized returns by passing in object, serializer, and an options
+  hash
+test_files: []