decoru 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8886ef6ee47213ebf8d205b17b006e2a7bf3332529683db0373d81ce24fa23f3
+  data.tar.gz: a16a0e63b1248971cb3dbe09dece5714072d7677b57182932572328a0604c64c
+SHA512:
+  metadata.gz: 5c14cbe3740c8b40406eca095782a5649cb9fcbf1f7d65b4c6246d16f0c6f8c87671fe5ccb231ad7f4f82893d9ce07996ff36933288b8d6a29f1c1dd17b21f59
+  data.tar.gz: b5087f1598dabca920cc1692e535edb58196917b76dfcfd9afdea035304f401c53566819ae4c487a8dfdd9eed2f22058627a72170e22b1ff430aa852135e34d3

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 2.0.2

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.1.0
+
+- First Release

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 lala.akira@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,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in decoru.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 aki
+
+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,49 @@
+# Decoru
+
+A simple decorator for Rails models.
+
+## Usage
+
+```ruby
+# app/controllers/users_controller.rb
+def show
+  @user = User.find(params[:id]).decorate
+end
+
+def index
+  @users = User.first(10).decorate
+end
+```
+
+```ruby
+# app/decorators/user_decorator.rb
+class UserDecorator < Decoru::Decorator
+  def full_name
+    [first_name, last_name].join(' ')
+  end
+end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'decoru'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install decoru
+```
+
+## 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,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 "decoru"
+
+# 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/decoru.gemspec

@@ -0,0 +1,34 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "decoru/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "decoru"
+  spec.version       = Decoru::VERSION
+  spec.authors       = ["aki77"]
+  spec.email         = ["aki77@users.noreply.github.com"]
+
+  spec.summary       = %q{A simple decorator for Rails models.}
+  spec.description   = %q{A simple decorator for Rails models.}
+  spec.homepage      = "https://github.com/aki77/decoru"
+  spec.license       = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/aki77/decoru"
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # 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_dependency "rails", ">= 5.2.0"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", ">= 12.3.3"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/decoru.rb

@@ -0,0 +1,8 @@
+require 'decoru/version'
+require 'decoru/railtie'
+require 'decoru/decorator'
+require 'decoru/decoratable'
+
+module Decoru
+  class UninferrableDecoratorError < NameError; end
+end

data/lib/decoru/decoratable.rb

@@ -0,0 +1,34 @@
+module Decoru
+  module Decoratable
+    extend ActiveSupport::Concern
+
+    class_methods do
+      # Decorate collection with appropriate decorator
+      def decorate
+        all.map(&:decorate)
+      end
+
+      # Infers the decorator class to be used by (e.g. `User` maps to `UserDecorator`).
+      # adapted from https://github.com/drapergem/draper/blob/157eb955072a941e6455e0121fca09a989fcbc21/lib/draper/decoratable.rb#L71
+      def decorator_class(called_on = self)
+        prefix = respond_to?(:model_name) ? model_name : name
+        decorator_name = "#{prefix}Decorator"
+        decorator_name_constant = decorator_name.safe_constantize
+        return decorator_name_constant unless decorator_name_constant.nil?
+
+        return superclass.decorator_class(called_on) if superclass.respond_to?(:decorator_class)
+
+        raise Decoru::UninferrableDecoratorError, "Could not infer a decorator for #{called_on.name}."
+      end
+    end
+
+    # Decorate object with appropriate decorator
+    def decorate
+      self.class.decorator_class.new(self)
+    end
+
+    def decorated?
+      false
+    end
+  end
+end

data/lib/decoru/decorator.rb

@@ -0,0 +1,24 @@
+require 'active_model'
+
+module Decoru
+  # adapted from https://github.com/thepracticaldev/dev.to/blob/2dbb558b30c15b2b77a7d67c41f8c9a303567e1f/app/decorators/application_decorator.rb
+  class Decorator
+    include ActiveModel::Serialization
+    include ActiveModel::Serializers::JSON
+
+    delegate_missing_to :@object
+
+    # ActiveModel compatibility
+    delegate :to_param, :to_partial_path, to: :@object
+
+    attr_reader :object
+
+    def initialize(object)
+      @object = object
+    end
+
+    def decorated?
+      true
+    end
+  end
+end

data/lib/decoru/railtie.rb

@@ -0,0 +1,11 @@
+require 'rails/railtie'
+
+module Decoru
+  class Railtie < Rails::Railtie
+    initializer :decoru do
+      ActiveSupport.on_load :active_record do
+        self.include Decoratable
+      end
+    end
+  end
+end

data/lib/decoru/version.rb

@@ -0,0 +1,3 @@
+module Decoru
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: decoru
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- aki77
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-03-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+- !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: A simple decorator for Rails models.
+email:
+- aki77@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- decoru.gemspec
+- lib/decoru.rb
+- lib/decoru/decoratable.rb
+- lib/decoru/decorator.rb
+- lib/decoru/railtie.rb
+- lib/decoru/version.rb
+homepage: https://github.com/aki77/decoru
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/aki77/decoru
+  source_code_uri: https://github.com/aki77/decoru
+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.3
+signing_key: 
+specification_version: 4
+summary: A simple decorator for Rails models.
+test_files: []