cerializable 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ad9653d367e90c3a5193cc66829ee77c94522dcc
+  data.tar.gz: 15ce70990ee56482735914313d184b6f9ddec8c6
+SHA512:
+  metadata.gz: 0bf553c69da8102511de80890a057d0e0d33cae3cf8a4b824ee5362877f20d9e1d598fb5e128572ff3f441d2ec6caa073850500da048a043f4294ff94bbdc608
+  data.tar.gz: 5ab2836756669bdbd69b110f8c93c5244ec18d92232d948ed9990ba252df78a6a83cb02a3e10cde6cfd46e0fc5978e4665b1377a108d688a38e96899b94195c2

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Eric Arnold
+
+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.rdoc

@@ -0,0 +1,48 @@
+= Cerializable
+
+Cerializable provides flexible custom serialization for Rails models.
+
+HOW TO USE
+
+Add Cerializable to your Gemfile
+
+    gem 'cerializable', git: 'git://github.com/nativestranger/cerializable.git', branch: 'master'
+
+Call 'acts_as_cerializable' in the models you wish to use Cerializable with.
+
+    class Comment < ApplicationRecord
+      acts_as_cerializable
+    end
+
+Define corresponding serializer modules.
+
+    module CommentSerializer
+
+      include ActionView::Helpers::DateHelper
+
+      def run(comment, options)
+        { id: comment.id,
+          user: { id: comment.user.id,
+                  name: comment.user.name },
+          body: comment.body,
+          ancestorCount: comment.ancestor_count,
+          childComments: options[:children] || comment.child_comments.order(id: :desc).map { |c| c.serializable_hash },
+          createdAtInWords: "#{ time_ago_in_words(comment.created_at) } ago" }
+      end
+
+    end
+
+The only requirement is that the 'run' method accepts two arguments and returns a hash which details how any given instance of your model is to be represented in JSON.
+
+Pass custom options to #as_json, #to_json, or #serializable_hash and your models will use the #run method of their serializers to produce the result.
+
+If you wish, you can specify the serializer module to use:
+
+    class Comment < ApplicationRecord
+      acts_as_cerializable serialize_with: SomeSerializerModule
+    end
+
+
+TODO:
+
+* Support #to_xml

data/Rakefile

@@ -0,0 +1,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Cerializable'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/cerializable.rb

@@ -0,0 +1,23 @@
+require 'cerializable/cerializer'
+require 'cerializable/acts_as_cerializable'
+
+module Cerializable
+
+  def self.setup(options) # :nodoc:
+    # evaluate code in the context of the base class
+    options[:base].class_eval do
+
+      # define a 'cerializer' class method on the base class.
+      # it returns a cerializer object which does the serialization for instances of the class.
+      define_singleton_method :cerializer, proc {
+        @cerializer ||= Cerializer.new.tap do |cerializer|
+          serializer_module = options[:serialize_with] || "#{ options[:base].name  }Serializer".constantize
+          # use class_eval to include the serializer module in the cerializer's eigenclass
+          cerializer.class_eval { include serializer_module }
+        end
+      }
+
+    end
+  end
+
+end

data/lib/cerializable/acts_as_cerializable.rb

@@ -0,0 +1,86 @@
+module Cerializable
+  module ActsAsCerializable
+    extend ActiveSupport::Concern
+
+    included do
+      # #serializable_hash delegates to the #run method of the model's 'cerializer' object.
+      #
+      # It accepts `:only`, `:except`, and `:methods` options which can be passed as a
+      # symbol or as an array of symbols.
+      #
+      # Using the `:only` option will return a hash that only has the specified keys.
+      #
+      #     > comment.serializable_hash(only: :id)
+      #     => { id: 1 }
+      #
+      # Using the `:except` option will return a hash that has all default keys except those specified.
+      #
+      #     > comment.serializable_hash(except: [:id, :user_id])
+      #     => { body: '...sushi? ;)', deleted_at: nil }
+      #
+      # Using the `:methods` option add will add a key and value for each method specified.
+      #
+      # The key is the method name as a symbol.
+      # The value is the return value given when calling the method on the model instance.
+      #
+      # The :methods option is processed after the :only and :except options.
+      #
+      #     > comment.serializable_hash(only: id, methods: :hash])
+      #     => { id: 1, hash: -2535926706119161824 }
+      #
+      def serializable_hash(options = {})
+        [:only, :except, :methods].each do |option_name|
+          break if options[:option_name].nil?
+
+          unless options[:option_name].is_a?(Symbol) || options[:option_name].is_a?(Array)
+            raise Exception, "'#{ option_name }' option must be of an Array or Symbol class."
+          end
+        end
+
+        # serialize the instance using the class's cerializer object.
+        hash = self.class.cerializer.run(self, options)
+
+        # alter the hash according to the :only, :except, and :methods serialization options.
+        ensure_is_array = proc { |arg| arg.class.ancestors.include?(Array) ? arg : Array.new(1, arg) }
+
+        if except_options = options[:except] && ensure_is_array.call(options[:except])
+          except_options.each { |key| hash.delete(key) }
+        end
+
+        if only_options = options[:only] && ensure_is_array.call(options[:only])
+          hash.keys.each { |key| hash.delete(key) unless only_options.include?(key) }
+        end
+
+        if methods_options = options[:methods] && ensure_is_array.call(options[:methods])
+          methods_options.each { |method_name| hash[method_name] = self.send(method_name) }
+        end
+
+        hash
+      end
+
+      alias :as_json :serializable_hash
+      alias :to_json :serializable_hash
+    end
+
+    module ClassMethods
+      # `acts_as_cerializable` is used to declare that a
+      # model uses Cerializable for serialization.
+      #
+      # Unless a module is specified via the
+      # +serialize_with+ option, the base model's cerializer will attempt
+      # to include a module based on the model's name.
+      #
+      # For example, calling +Comment.acts_as_cerializable+ without a +serialize_with+
+      # option will cause Cerializable to look for a +CommentSerializer+.
+      #
+      # Calling +Comment.acts_as_cerializable+ +serialize_with:+ +MySerializer+
+      # will cause Cerializable to look for a +MySerializer+ instead.
+      def acts_as_cerializable(options = {})
+        Cerializable.setup(options.merge(base: self))
+      end
+    end
+
+  end
+end
+
+ActiveRecord::Base.send :include, Cerializable::ActsAsCerializable

data/lib/cerializable/cerializer.rb

@@ -0,0 +1,9 @@
+module Cerializable
+  # Cerializable::Cerializer instances are used to do the serialization
+  # for models that use +acts_as_cerializable+.
+  #
+  # Each Cerializable::Cerializer instance includes the serializer
+  # module for its model.
+  class Cerializer
+  end
+end

data/lib/cerializable/version.rb

@@ -0,0 +1,3 @@
+module Cerializable
+  VERSION = "0.0.1"
+end

data/lib/tasks/cerializable_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :cerializable do
+#   # Task goes here
+# end

data/test/acts_as_cerializable_test.rb

@@ -0,0 +1,52 @@
+require 'test_helper'
+
+class ActsAsCerializableTest < ActiveSupport::TestCase
+
+  test "ActiveRecord::Base#acts_as_cerializable" do
+    assert true, ActiveRecord::Base.respond_to?(:acts_as_cerializable)
+  end
+
+  # Ensure both models are serializing their instances as expected
+  [Model, AnotherModel].each { |model_class|
+
+    test "#{ model_class.name }#cerializer is defined" do
+      assert_equal model_class.send(:cerializer).class, Cerializable::Cerializer
+      assert true, model_class.send(:cerializer).respond_to?(:run)
+    end
+
+    expected_result = model_class.send(:default_json_representation)
+    [:serializable_hash, :as_json, :to_json].each do |method_name|
+
+      test "#{ model_class.name.downcase }##{ method_name } works as expected" do
+        instance = model_class.send(:new)
+
+        assert_equal instance.send(method_name), expected_result
+
+        # except option
+        assert_equal instance.send(method_name, except: :arbitraryKey1), expected_result.except(:arbitraryKey1)
+
+        assert_equal instance.send(method_name, except: [:arbitraryKey1, :arbitraryKey2]),
+                     expected_result.except(:arbitraryKey1, :arbitraryKey2)
+
+        # only option
+        assert_equal instance.send(method_name, only: :arbitraryKey1), expected_result.slice(:arbitraryKey1)
+
+        assert_equal instance.send(method_name, only: [:arbitraryKey1, :arbitraryKey2]),
+                     expected_result.slice(:arbitraryKey1, :arbitraryKey2)
+
+        # method option
+        assert_equal instance.send(method_name, methods: :object_id),
+                     expected_result.merge(object_id: instance.object_id)
+
+        assert_equal instance.send(method_name, methods: [:object_id, :hash]),
+                     expected_result.merge(object_id: instance.object_id, hash: instance.hash)
+
+        # custom option
+        assert_equal instance.send(method_name, custom_option: true),
+                     expected_result.merge(customOption: '( ͡° ͜ʖ ͡°)')
+      end
+    end
+
+  }
+
+end

data/test/cerializable_test.rb

@@ -0,0 +1,21 @@
+require 'test_helper'
+
+class CerializableTest < ActiveSupport::TestCase
+
+  test "Cerializable is defined" do
+    assert_kind_of Module, Cerializable
+  end
+
+  test "Cerializable#setup is defined" do
+    assert true, Cerializable.respond_to?(:setup)
+  end
+
+  test "Cerializable::Cerializer is defined" do
+    assert_kind_of Class, Cerializable::Cerializer
+  end
+
+  test "Cerializable::ActsAsCerializable is defined" do
+    assert_kind_of Module, Cerializable::ActsAsCerializable
+  end
+
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/models/another_model.rb

@@ -0,0 +1,9 @@
+class AnotherModel < ActiveRecord::Base
+  # the :serialize_with option allows you to specify a serialization module
+  acts_as_cerializable serialize_with: AnotherSerializer
+
+  # this is here just to make testing easier
+  def self.default_json_representation
+    { arbitraryKey3: 'arbitrary value', arbitraryKey4: 'another arbitrary value' }
+  end
+end

data/test/dummy/app/models/model.rb

@@ -0,0 +1,9 @@
+class Model < ActiveRecord::Base
+  # by default, Cerializable#setup will look for a module named "#{ model_name }Serializer"
+  acts_as_cerializable
+
+  # this is here just to make testing easier
+  def self.default_json_representation
+    { arbitraryKey1: 'value', arbitraryKey2: 'another value' }
+  end
+end

data/test/dummy/app/serializers/another_serializer.rb

@@ -0,0 +1,6 @@
+module AnotherSerializer
+  def run(model, options = {})
+    result = AnotherModel.default_json_representation
+    options[:custom_option] ? result.merge(customOption: '( ͡° ͜ʖ ͡°)') : result
+  end
+end

data/test/dummy/app/serializers/model_serializer.rb

@@ -0,0 +1,6 @@
+module ModelSerializer
+  def run(model, options = {})
+    result = Model.default_json_representation
+    options[:custom_option] ? result.merge(customOption: '( ͡° ͜ʖ ͡°)') : result
+  end
+end