ivy-serializers-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 223c377f7969b7bde8b5d281bd69941a79100343
+  data.tar.gz: 0c64797097a46a1589b8d1cea0f20e4d48c25dd9
+SHA512:
+  metadata.gz: 7394a529a72464fcada031b5e2b0ad9c6ffc09c73a21f9eb9a4ac3c028aa947eaa0b31d1ffbc68f367aec9a4852cf339addf4282bdd70b1ad8aa39a4e48b675f
+  data.tar.gz: 02cc0b6465347dc774a45d015760c25f4989cd796eff5064fe657f065027f3eab3dfc1d4d915b0bc6a738f9ad2555ebaa556b581990c956444eb29a4dca08b1d

data/.gitignore

@@ -0,0 +1,12 @@
+*.log
+*.sqlite
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/gemfiles/*.lock
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,18 @@
+language: ruby
+
+rvm:
+  - 2.2.2
+  - 1.9.3
+
+cache: bundler
+
+before_install: gem install bundler -v 1.9.4
+
+gemfile:
+  - gemfiles/rails_3.x.gemfile
+  - gemfiles/rails_4.x.gemfile
+
+notifications:
+  email:
+    on_success: change
+    on_failure: always

data/Appraisals

@@ -0,0 +1,8 @@
+appraise "rails-3.x" do
+  gem "test-unit", "~> 3.0"
+  gem "rails", "~> 3.2"
+end
+
+appraise "rails-4.x" do
+  gem "rails", "~> 4.0"
+end

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,73 @@
+# ivy-serializers-rails
+
+[![Build Status](https://travis-ci.org/IvyApp/ivy-serializers-rails.svg?branch=master)](https://travis-ci.org/IvyApp/ivy-serializers-rails)
+
+Rails integration for
+[ivy-serializers](https://github.com/ivyapp/ivy-serializers).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ivy-serializers-rails'
+```
+
+And then execute:
+
+```sh
+bundle
+```
+
+Or install it yourself with:
+
+```sh
+gem install ivy-serializers-rails
+```
+
+## Usage
+
+See the [ivy-serializers docs](https://github.com/IvyApp/ivy-serializers/blob/master/README.md#usage)
+for how to define a serializer. Once you've done that, set up your
+controller(s) to use your serializer:
+
+```ruby
+class ApplicationController < ActionController::Base
+  self.serializer = MySerializer
+end
+```
+
+Note that you're not limited to a single serializer. If you have multiple
+serialization formats, such as one for admin and one for public-facing, you can
+define alternate serializers in `app/serializers` and use them as well.
+
+### Alternate Output Formats
+
+By default the ActiveModel::Serializers output format is used. If you'd rather
+use JSON-API (or a custom format), you can do so by setting
+`serialization_format` in your controller. For instance, to use JSON-API:
+
+```ruby
+class ApplicationController < ActionController::Base
+  self.serialization_format = Ivy::Serializers::Formats::JSONAPI
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git
+commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/ivy-serializers-rails/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+desc 'Default: run specs.'
+task :default => :spec

data/config.ru

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'bundler'
+
+Bundler.require :default, :development
+
+Combustion.initialize! :all
+run Combustion::Application

data/gemfiles/rails_3.x.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "test-unit", "~> 3.0"
+gem "rails", "~> 3.2"
+
+gemspec :path => "../"

data/gemfiles/rails_4.x.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 4.0"
+
+gemspec :path => "../"

data/ivy-serializers-rails.gemspec

@@ -0,0 +1,29 @@
+require File.expand_path('../lib/ivy/serializers/rails/version', __FILE__)
+
+Gem::Specification.new do |spec|
+  spec.name = 'ivy-serializers-rails'
+  spec.version = Ivy::Serializers::Rails::VERSION
+  spec.authors = ['Dray Lacy']
+  spec.email = ['dray@envylabs.com']
+
+  spec.summary = 'Rails integration for ivy-serializers.'
+  spec.homepage = 'https://github.com/IvyApp/ivy-serializers-rails'
+
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'ivy-serializers', '~> 0.2'
+  spec.add_dependency 'railties', '>= 3.2.6', '< 5'
+
+  spec.add_development_dependency 'appraisal', '~> 2.0'
+  spec.add_development_dependency 'bundler', '~> 1.9'
+  spec.add_development_dependency 'combustion', '~> 0.5.3'
+  spec.add_development_dependency 'json-schema-rspec'
+  spec.add_development_dependency 'rails', '~> 4.2.1'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec-rails', '~> 3.2.1'
+  spec.add_development_dependency 'simplecov', '~> 0.10.0'
+  spec.add_development_dependency 'sqlite3', '~> 1.3.10'
+end

data/lib/ivy/serializers/rails.rb

@@ -0,0 +1,2 @@
+require 'ivy/serializers/rails/version'
+require 'ivy/serializers/rails/railtie'

data/lib/ivy/serializers/rails/action_controller/serialization_support.rb

@@ -0,0 +1,39 @@
+require 'active_support'
+
+module Ivy
+  module Serializers
+    module Rails
+      module ActionController
+        module SerializationSupport
+          extend ActiveSupport::Concern
+
+          class SerializerNotFound < ::StandardError
+          end
+
+          included do
+            class_attribute :serializer, :instance_writer => false
+            class_attribute :serialization_format, :instance_writer => false
+            self.serialization_format = ::Ivy::Serializers::Formats::ActiveModelSerializers
+          end
+
+          private
+
+          %w[ _render_option_json _render_with_renderer_json ].each do |renderer_method|
+            define_method(renderer_method) do |resource, options|
+              unless serializer
+                raise SerializerNotFound, "No serializer found in #{self.class.name}"
+              end
+
+              unless resource.kind_of?(::Hash)
+                resource = ::Ivy::Serializers::Documents.create(serializer, controller_name, resource)
+                resource = options.fetch(:serialization_format) { self.class.serialization_format }.new(resource)
+              end
+
+              super(resource, options)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ivy/serializers/rails/railtie.rb

@@ -0,0 +1,17 @@
+require 'ivy/serializers'
+require 'ivy/serializers/rails/action_controller/serialization_support'
+require 'rails'
+
+module Ivy
+  module Serializers
+    module Rails
+      class Railtie < ::Rails::Railtie
+        initializer 'ivy.serializers.controllers' do
+          ActiveSupport.on_load(:action_controller) do
+            include ::Ivy::Serializers::Rails::ActionController::SerializationSupport
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ivy/serializers/rails/version.rb

@@ -0,0 +1,7 @@
+module Ivy
+  module Serializers
+    module Rails
+      VERSION = '0.1.0'
+    end
+  end
+end

metadata

@@ -0,0 +1,218 @@
+--- !ruby/object:Gem::Specification
+name: ivy-serializers-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dray Lacy
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-05-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ivy-serializers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.6
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.6
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: combustion
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.3
+- !ruby/object:Gem::Dependency
+  name: json-schema-rspec
+  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: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.1
+- !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-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.10
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.10
+description: 
+email:
+- dray@envylabs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Appraisals
+- Gemfile
+- README.md
+- Rakefile
+- config.ru
+- gemfiles/rails_3.x.gemfile
+- gemfiles/rails_4.x.gemfile
+- ivy-serializers-rails.gemspec
+- lib/ivy/serializers/rails.rb
+- lib/ivy/serializers/rails/action_controller/serialization_support.rb
+- lib/ivy/serializers/rails/railtie.rb
+- lib/ivy/serializers/rails/version.rb
+homepage: https://github.com/IvyApp/ivy-serializers-rails
+licenses: []
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Rails integration for ivy-serializers.
+test_files: []