tiny_decorator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 556129b98566d8008a5debe82b1b482fdca17b671a7f5216efe52b6cb3c133a9
+  data.tar.gz: bbe8d99109236b1af9f6b0627e7efb5de0bb609a02a3113fbb940812da8e71eb
+SHA512:
+  metadata.gz: a7c87eab3b528b9cbbdc1cb63550a2d64bcfff06bfe15bc5af5db13a3abdce1153ec09615c96bbeb56cb06c2cc4c73c8e0a52f7841134d9c231585e5ee97b8aa
+  data.tar.gz: 8decc6dd24638f49b3c71a4165a9d92353689943b4ee48accf6514188256d35ed7d9195f445da1c219b66f277dd2d24f1652dd2b651770d1e9d4ef9d8054ffc4

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+*.sublime-project
+*.sublime-workspace

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-gemset

@@ -0,0 +1 @@
+tiny_decorator

data/.ruby-version

@@ -0,0 +1 @@
+2.5

data/.travis.yml

@@ -0,0 +1,15 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5
+before_install: gem install bundler -v 1.17.1
+script:
+  - bundle exec rspec
+deploy:
+  provider: rubygems
+  api_key:
+    secure: VfAdlKJmGqIjszXJBt20n3u/l0seyZNWbfrOTMTjAfL7zeIqGEEE82VVXJPXpZukH1/2n61MxmSCwfqXosfnQ7bjYOTXloIVNY8A8KHDC0BJBmzNN1Ex6neFoEl33Gw8+0pVToUiJpDbw8RUSND9yyNDM9P44BCS9yRoYPRKmb8kdyf57y4lB8d+guPPl6O/SwJ5t9KpazNEQYJuWmSzY5hebooVgp4ZjD/GH3XbsgzdGo/Qrv4D1Ie782J6QO/KPCbFIx6/EBwi4iDjWSp843bto5UVSlHY0HNcr9jmUxV/Egom/ISgizZNDjPgmuQNzpkgzPdYPnKg68iFZDY7Qhik9RPQTRotCYPqk9sGu2W3E9dYEIfD4ddMnl5bWvufS7x2z/B3t4fEw44be1Tn9VuBDWn7SyJU140GXz8SxvzyAz6UUFBtA+02g7S+Tci6P63G1S65pccFUc/T5+pgfYwA+7ykUiSIWYQaJx0SYJPrk2yOphFJmFfQp6wF25K177C6uwJvSof7PhHcLJiwB6O5qSpHx8O70M4zPcZcgrKRMWPh+PJfIyukif/Jxp5CCyaYwGvbqg1Ox9M6/SonsbNBgBefclJziIgTWre5nXjSHZaEW5QNdprGyBEoF1aTpR/lRozutuX5PgxyM4NfZ4zGvbkOAnZ6rncza0zurnk=
+  gem: tiny_decorator
+  on:
+    tags: true
+    repo: anvox/tiny_decorator

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at thien.an.vo.nguyen@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in tiny_decorator.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    tiny_decorator (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  tiny_decorator!
+
+BUNDLED WITH
+   1.17.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 An Vo
+
+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,82 @@
+
+[![Build Status](https://travis-ci.org/anvox/tiny_decorator.svg?branch=master)](https://travis-ci.org/anvox/tiny_decorator)
+
+# TinyDecorator
+
+The world of ruby decorator is dominated by `draper`, I use it all the time.
+But when project grows and we chase the dealine, the flexible and easily of `draper` make us keep abusing it. Now, when using a decorated model we dont know which method/attribute are define in which decorator, which decorators depend on which ones.
+`tiny_decorator` aims to separate decoration logic into different decorators, and centralize logic to determine which decorators are used. It isn't built to replace `draper` as it just solve our internal problem of abusing `draper`, it's better if you using `draper` wisely instead `tiny_decorator`
+
+But if you're interesting in this gem, every contributes are welcome.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tiny_decorator'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tiny_decorator
+
+## Usage
+
+Model decorated by 1 single decorator
+```ruby
+  class NewDecorator < TinyDecorator::SingleDecorator
+    def new_method
+      'decorated'
+    end
+  end
+
+  NewDecorator.decorate(Object.new).new_method # 'decorated'
+  NewDecorator.decorate_collection([Object.new, Object.new])[1].new_method # 'decorated'
+```
+
+Model decorate by more than 1 decorators
+```ruby
+  class NewDecorator2
+    extend TinyDecorator::CompositeDecorator
+
+    decorated_by :default, 'DefaultDecorator'
+
+    decorated_by :nil, ->(record) { record.nil? ? 'NilDecorator' : 'DefaultDecorator' }
+    decorated_by :nil, ->(record, context) { record.in(context).nil? ? 'NilDecorator' : 'DefaultDecorator' }
+  end
+```
+
+And use it
+```ruby
+context = { current_user: user }
+#
+NewDecorator.decorate(model)
+NewDecorator.decorate(model, context)
+# OR
+NewDecorator.decorate_collection(models)
+NewDecorator.decorate_collection(models, context)
+
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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/anvox/tiny_decorator. 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](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the TinyDecorator project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/anvox/tiny_decorator/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

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

@@ -0,0 +1,97 @@
+module TinyDecorator
+  #
+  # Passing only decorator name, object will be decorated
+  # ```
+  #   extend TinyDecorator::CompositeDecorator
+  #   decorated_by :default, 'DefaultDecorator'
+  # ```
+  #
+  # Passing only 1 block param to #decorated_by
+  # Execute block to get decorator name.
+  # ```
+  #   extend TinyDecorator::CompositeDecorator
+  #   decorated_by :default, ->(record) { record.nil? ? 'NilDecorator' : 'DefaultDecorator' }
+  #   decorated_by :default, ->(record, context) { record.in(context).nil? ? 'NilDecorator' : 'DefaultDecorator' }
+  # ```
+  #
+  # Passing decorator name and 1 block param to #decorated_by
+  # Execute block to determine should we decorate it or not
+  # ```
+  #   extend TinyDecorator::CompositeDecorator
+  #   decorated_by :default, ->(record) { record.valid? ? 'ValidDecorator' : 'InvalidDecorator' }
+  #   decorated_by :default, ->(record, context) { record.in(context).valid? ? 'ValidDecorator' : 'InvalidDecorator' }
+  # ```
+  #
+  # For now, `:name` is redundant, but it's nice to have a friendly name for readbility and later usage
+  #
+  # Block may receive
+  #   1 parameter is record to decorate OR
+  #   2 parameters are record to decorate and context
+  #
+  # CompositeDecorator introduces a central conditional decorator manager.
+  # It answer the questions: which decorater will be used in which conditions.
+  # The decorator is a sub class of TinyDecorator::BaseDelegator (or draper decorator, but not recommend)
+  # TinyDecorator::BaseDelegator will answer the question which attributes are decorated.
+  #
+  module CompositeDecorator
+    # Decorate collection of objects, each object is decorate by `#decorate`
+    # TODO: [AV] It's greate if with activerecord relationshop, we defer decorate until data retrieved.
+    #       Using `map` will make data retrieval executes immediately
+    def decorate_collection(records, context = {})
+      Array(records).map do |record|
+        decorate(record, context)
+      end
+    end
+
+    # Decorate an object by defined `#decorated_by`
+    def decorate(record, context = {})
+      if instance_variable_get(:@_contexts)
+        context = context.merge(instance_variable_get(:@_contexts).inject({}) do |carry, (context_name, context_block)|
+          context[context_name] = context_block.call(record, context)
+
+          carry
+        end)
+      end
+
+      instance_variable_get(:@decorators).inject(record) do |carry, (name, value)|
+        decorator = decorator_resolver(name, value, record, context)
+        if decorator
+          carry = begin
+            const_get(decorator, false)
+          rescue NameError
+            Object.const_get(decorator, false)
+          end.decorate(carry, context)
+        end
+
+        carry
+      end
+    end
+
+    private
+
+    def decorated_by(decorate_name, class_name, condition_block = nil)
+      decorators = instance_variable_get(:@decorators) || {}
+      decorators[decorate_name] = [class_name, condition_block]
+      instance_variable_set(:@decorators, decorators)
+    end
+
+    def set_context(context_name, context_block)
+      _contexts = instance_variable_get(:@_contexts) || {}
+      _contexts[context_name] = context_block
+      instance_variable_set(:@_contexts, _contexts)
+    end
+
+    # Resolve decorator class from #decorated_by definition
+    # if 1st param is a block, evaluate it as decorator name
+    # if 1st param isn't a block
+    #     if no 2nd param, 1st param is decorator name
+    #     if 2nd param exists, evaluate it as boolean to determine decorate or not
+    def decorator_resolver(_name, value, record, context)
+      if value[0].respond_to?(:call)
+        ((value[0].arity == 1 && value[0].call(record)) || (value[0].arity == 2 && value[0].call(record, context)))
+      elsif value[1].nil? || (value[1].arity == 1 && value[1].call(record)) || (value[1].arity == 2 && value[1].call(record, context))
+        value[0]
+      end
+    end
+  end
+end

data/lib/tiny_decorator/single_decorator.rb

@@ -0,0 +1,41 @@
+module TinyDecorator
+  # Single decorator. Inherite, then define methods to use.
+  # This base decorator delegates all. To limit delegation to source object.
+  #
+  # ```
+  # class NewDecorator < TinyDecorator::SingleDecorator
+  #   def new_method
+  #     'decorated'
+  #   end
+  # end
+  #
+  # NewDecorator.decorate(Object.new).new_method # 'decorated'
+  # NewDecorator.decorate_collection([Object.new, Object.new])[1].new_method # 'decorated'
+  # ```
+  #
+  # Use in case source has only 1 decorator.
+  # In case more than 1 decorator or conditional decorate, we prefer using `TinyDecorator::CompositeDecorator`
+  class SingleDecorator < SimpleDelegator
+    # Initialize, use `.decorate` or `.new` are the same
+    # @param delegatee [Object] source object to decorate
+    # @param context [Hash] context as hash, could read within decorator scope by `context[]`
+    def initialize(delegatee, context = {})
+      @context = context
+      __setobj__(delegatee)
+    end
+    attr_reader :context
+
+    class << self
+      # Decorate a collection, collection must extend Enum behavior
+      # @param delegatees [Array] collection of source object to decorate
+      # @param context [Hash] context as hash, could read within decorator scope by `context[]`
+      def decorate_collection(delegatees, context = {})
+        delegatees.map do |delegatee|
+          new(delegatee, context)
+        end
+      end
+
+      alias decorate new
+    end
+  end
+end

data/lib/tiny_decorator/version.rb

@@ -0,0 +1,3 @@
+module TinyDecorator
+  VERSION = "0.1.0"
+end

data/lib/tiny_decorator.rb

@@ -0,0 +1,7 @@
+require "tiny_decorator/version"
+
+module TinyDecorator
+end
+
+require 'tiny_decorator/single_decorator'
+require 'tiny_decorator/composite_decorator'

data/tiny_decorator.gemspec

@@ -0,0 +1,39 @@
+# coding: utf-8
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "tiny_decorator/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "tiny_decorator"
+  spec.version       = TinyDecorator::VERSION
+  spec.authors       = ['An Vo']
+  spec.email         = ['thien.an.vo.nguyen@gmail.com']
+
+  spec.summary       = 'A simple decorator untility module'
+  spec.description   = 'Inspire by draper. But draper is too overkill, and I want to avoid decorator abusing.'
+  spec.homepage      = 'https://github.com/anvox/tiny_decorator'
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  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
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: tiny_decorator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- An Vo
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-02-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Inspire by draper. But draper is too overkill, and I want to avoid decorator
+  abusing.
+email:
+- thien.an.vo.nguyen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/tiny_decorator.rb
+- lib/tiny_decorator/composite_decorator.rb
+- lib/tiny_decorator/single_decorator.rb
+- lib/tiny_decorator/version.rb
+- tiny_decorator.gemspec
+homepage: https://github.com/anvox/tiny_decorator
+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: []
+rubygems_version: 3.0.2
+signing_key: 
+specification_version: 4
+summary: A simple decorator untility module
+test_files: []