decoradar 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fd22f41ffbe6e0672c15ff80f6842b9b2124f2b4
+  data.tar.gz: fa91fdfb2330c29245163453b3e6f81597f78aa2
+SHA512:
+  metadata.gz: ff008b9657b99195cef9276feff673f053cd07b90198756e7d55ae21bda69a57314608ee39ee32f2ed03b0e9d5297a8e886932d1b4c432f08a9a6a63fc1571e6
+  data.tar.gz: 0ac03a46b7101e2c6b998078317494ad4d3333cfbb227623f35338a990c3fff5dad29d75ae307434c3ed20d23b3bd2a267ed4574d02c3e5c2a243245ec2dab95

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.2
+  - 2.3.0
+before_install: gem install bundler -v 1.12.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+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.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at huynhquancam@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in decoradar.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Cẩm Huỳnh
+
+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,95 @@
+# Decoradar
+
+Decoradar is a simple decorator + serializer in Ruby
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'decoradar'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install decoradar
+
+## Why Decoradar?
+
+Decoradar is really **simple** (it has only 2 classes as of writing) and **magic-free** (zero monkey patch, zero auto coercion)
+and aims to bring ActiveModel::Serializer/Draper DSL-style declaration to Plain Ruby Object.
+
+## Usage
+
+```ruby
+class UserSerializer
+  include Decoradar
+
+  attributes :id, :username
+  attribute :full_name, as: :name
+end
+
+UserSerializer.new(@user).as_json
+# => { id: 1, username: "huynhquancam", name: "Cam Huynh" }
+```
+
+Let's say you want to tweak `full_name` a bit.
+
+```ruby
+class UserSerializer
+  include Decoradar
+
+  attributes :id, :name
+  attribute :full_name, as: :name
+
+  def full_name
+    model.full_name.capitalize
+  end
+end
+
+UserSerializer.new(@user).as_json
+# => { id: 1, username: "huynhquancam", name: "CAM HUYNH" }
+```
+
+If we want the serialized hash to include an attribute as long as it exists, we can use `include_if` option.
+
+```ruby
+class UserSerializer
+  include Decoradar
+
+  attribute :id
+  attribute :username
+  attribute :is_admin, include_if: ->(model) { model.admin? }
+end
+
+UserSerializer.new(@mark).as_json
+# => { id: 1, username: "zuck", is_admin: true }
+
+UserSerializer.new(@trump).as_json
+# => { id: 1, username: "realDonaldTrump" }
+```
+
+If you want to serialize a collection, there's **NO AUTO-MAGIC COERCION**, just uses `.decorate_collection`.
+
+```ruby
+UserSerializer.decorate_collection(@users).map(&:as_json)
+```
+
+## Development
+
+1. Fork this repo.
+2. Make your change and submit pull request (with specs please :smile:)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/huynhquancam/decoradar.
+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](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

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

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/decoradar.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'decoradar/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "decoradar"
+  spec.version       = Decoradar::VERSION
+  spec.authors       = ["Cẩm Huỳnh"]
+  spec.email         = ["huynhquancam@gmail.com"]
+
+  spec.summary       = %q{Simple decorator + serializer}
+  spec.description   = %q{Simple decorator + serializer in Ruby}
+  spec.homepage      = "https://github.com/huynhquancam/decoradar"
+  spec.license       = "MIT"
+
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  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_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.5"
+end

data/lib/decoradar/attribute.rb

@@ -0,0 +1,23 @@
+module Decoradar
+  class Attribute
+    attr_reader :name, :as, :include_if
+
+    def initialize(options = {})
+      @name = options.fetch(:name)
+      @as = options.fetch(:as, @name)
+      @include_if = options[:include_if]
+    end
+
+    def including?(object)
+      case include_if
+      when nil then true
+      when Proc then include_if.call(object)
+      else false
+      end
+    end
+
+    def serialize(hash, value)
+      hash.merge(as => value)
+    end
+  end
+end

data/lib/decoradar/version.rb

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

data/lib/decoradar.rb

@@ -0,0 +1,85 @@
+require 'set'
+require 'decoradar/attribute'
+
+# Decorates and serializes model into a hash
+#
+# class PlayerDecorator
+#   include Decoradar
+#
+#   attributes :id, :name, :team
+#   attribute :shirt_number
+#   attribute :nationality, include_if: -> model { model.has_nationality? }
+#
+#   def shirt_number
+#     model.team.shirt
+#   end
+#
+#   def team
+#     TeamDecorator.new(model.team)
+#   end
+# end
+#
+# PlayerDecorator.new(Player.first).as_json
+module Decoradar
+  def self.included(base)
+    base.singleton_class.class_eval { attr_accessor :attribute_set }
+
+    base.class_eval do
+      self.attribute_set = Set.new
+
+      extend Forwardable
+      extend ClassMethods
+      include InstanceMethods
+    end
+  end
+
+  module ClassMethods
+    def attributes(*names)
+      names.map { |name| attribute(name) }
+    end
+
+    def attribute(name, options = {})
+      attr = Attribute.new(options.merge(name: name))
+      self.attribute_set << attr
+      class_eval { def_delegators(:model, attr.name) }
+    end
+
+    def decorate_collection(collection)
+      raise TypeError if !collection.respond_to?(:map)
+
+      collection.map { |item| new(item) }
+    end
+
+    def inherited(child)
+      child.attribute_set = attribute_set.dup
+
+      super
+    end
+  end
+
+  module InstanceMethods
+    attr_reader :model
+
+    def initialize(model)
+      @model = model
+    end
+
+    def as_json(_options = nil)
+      self.class.attribute_set.reduce({}) do |json, attribute|
+        enrich_json(json, attribute)
+      end
+    end
+
+    def enrich_json(json, attribute)
+      if attribute.including?(model)
+        attribute.serialize(json, value_of(attribute))
+      else
+        json
+      end
+    end
+
+    def value_of(attribute)
+      self.public_send(attribute.name.to_sym)
+    end
+  end
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: decoradar
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Cẩm Huỳnh
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-01-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+description: Simple decorator + serializer in Ruby
+email:
+- huynhquancam@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- decoradar.gemspec
+- lib/decoradar.rb
+- lib/decoradar/attribute.rb
+- lib/decoradar/version.rb
+homepage: https://github.com/huynhquancam/decoradar
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.5
+signing_key: 
+specification_version: 4
+summary: Simple decorator + serializer
+test_files: []