deckorator 0.1.0.beta1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d5765363d772f05056fdf0086b322eac68994dc4
+  data.tar.gz: 57305700c3cc0d99918693895fb59e70c1d30bb5
+SHA512:
+  metadata.gz: ce7157db635f90996a5f15038c33e7a8ae6c3bb91938131de943422bf50c2638005daf5b5355ed713aa0bd06fd24c0a311cf3b0d30108a364367165960a62ec3
+  data.tar.gz: d2d3a5c89d94996f1a6dc5d63ce09fa0d777072e97262ae7ab5b2037bb5239e4e292419ee32f40e345a49f9b6c7d18320a99983bea9f5bcab1491c55514dc3aa

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.11.2

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 johnotander@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 deckorator.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 John Otander, Jake Mays
+
+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,104 @@
+# deckorator [![Build Status](https://travis-ci.org/johnotander/deckorator.svg?branch=master)](https://travis-ci.org/johnotander/deckorator)
+
+Deckorator is a PORO (plain old Ruby object) implementation of the [Decorator](https://en.wikipedia.org/wiki/Decorator_pattern) pattern.
+It can be easily integrated into Rails/Sinatra apps or any other Ruby project.
+
+## Installation
+
+```ruby
+gem 'deckorator'
+```
+
+Then run bundler
+
+```sh
+$ bundle
+```
+
+Or, install it yourself as
+
+```sh
+$ gem install deckorator
+```
+
+#### With Rails
+
+Include `Deckorator` in the application controller
+
+```rb
+class ApplicationController < ActionController::Base
+  include Deckorator
+end
+```
+
+Then, run the install generator
+
+```sh
+$ rails g deckorator:install
+```
+
+An application decorator will be placed in `app/decorators`.
+
+## Usage
+
+Using the `decorate` method in the controller
+
+```rb
+class UsersController < ApplicationController
+  before_action :set_user
+
+  def show
+    @user = decorate(@user)
+  end
+
+  private
+
+  def set_user
+    @user = User.find(params[:id])
+  end
+end
+```
+
+#### Example decorator
+
+```rb
+class UserDecorator < ApplicationDecorator
+
+  def full_name
+    if first_name.blank? && last_name.blank?
+      'Unnamed User'
+    else
+      "#{first_name} #{last_name}".strip
+    end
+  end
+end
+```
+
+#### There's a generator
+
+```sh
+$ rails g deckorator:decorator user
+```
+
+This will create a `UserDecorator` in the `app/decorators` directory while also generating a stubbed test.
+
+## Related
+
+* <https://github.com/drapergem/draper>
+* <https://github.com/elabs/pundit>
+
+## License
+
+MIT
+
+## Contributing
+
+1. Fork it
+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 new Pull Request
+
+***
+
+> Crafted with <3 by [John Otander](https://twitter.com/4lpine) and [Jake Mays](https://github.com/bravely).

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 "deckorator"
+
+# 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/deckorator.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'deckorator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "deckorator"
+  spec.version       = Deckorator::VERSION
+  spec.authors       = ['John Otander', 'Jake Mays']
+  spec.email         = ['johnotander@gmail.com', 'jake.m.mays@gmail.com']
+
+  spec.summary       = %q{Lightweight decorators using plain old Ruby objects.}
+  spec.description   = %q{Lightweight decorators using plain old Ruby objects.}
+  spec.homepage      = 'https://github.com/johnotander/deckorator'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem 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
+
+  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 'activesupport', '>= 3.0.0'
+  spec.add_development_dependency "activemodel", ">= 3.0.0"
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/deckorator.rb

@@ -0,0 +1,26 @@
+require 'deckorator/version'
+require 'deckorator/delegator'
+require 'deckorator/finder'
+
+module Deckorator
+  class << self
+    def decorate(record)
+      if record.kind_of?(Array) || record.respond_to?(:all)
+        decorator_array = []
+        record.each do |r|
+          decorator_array << decorate_object(r)
+        end
+        decorator_array
+      else
+        decorate_object(record)
+      end
+    end
+  end
+
+  private
+
+  def self.decorate_object(record)
+    decorator = Deckorator::Finder.find(record)
+    decorator.new(record) if decorator
+  end
+end

data/lib/deckorator/delegator.rb

@@ -0,0 +1,9 @@
+module Deckorator
+  module Delegator
+    def method_missing(method, *args, &block)
+      decorated_object.respond_to?(method) ?
+        decorated_object.send(method, *args, &block) :
+        super
+    end
+  end
+end

data/lib/deckorator/finder.rb

@@ -0,0 +1,26 @@
+require 'active_support/core_ext/string/inflections'
+
+module Deckorator
+  class Finder
+    SUFFIX = 'Decorator'
+
+    def self.find(record)
+      if record.nil?
+        nil
+      elsif record.class.respond_to?(:decorator_class)
+        record.class.decorator_class
+      elsif record.respond_to?(:decorator_class)
+        record.decorator_class
+      else
+        klass = if record.class.respond_to?(:model_name)
+          record.class.model_name
+        elsif record.respond_to?(:model_name)
+          record.model_name
+        else
+          record.class
+        end
+        "#{klass}#{SUFFIX}".constantize
+      end
+    end
+  end
+end

data/lib/deckorator/version.rb

@@ -0,0 +1,3 @@
+module Deckorator
+  VERSION = '0.1.0.beta1'
+end

data/lib/generators/deckorator/decorator/decorator_generator.rb

@@ -0,0 +1,11 @@
+module Deckorator
+  module Generators
+    class DecoratorGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+
+      def create_decorator
+        template 'decorator.rb', File.join('app/policies', class_path, "#{file_name}_decorator.rb")
+      end
+    end
+  end
+end

data/lib/generators/deckorator/decorator/templates/decorator.rb

@@ -0,0 +1,9 @@
+<% module_namespacing do %>
+  class <%= class_name %>Decorator < ApplicationDecorator
+    # Here you can add decorator logic to pretty up your views
+    #
+    # def full_name
+    #   "#{first_name} #{last_name}".strip
+    # end
+  end
+<% end %>

data/lib/generators/deckorator/install/USAGE

@@ -0,0 +1,2 @@
+Description:
+    Generates an application decorator as a base for your application's decorators.

data/lib/generators/deckorator/install/install_generator.rb

@@ -0,0 +1,12 @@
+module Deckorator
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      source_root File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+
+      def copy_application_decorator
+        template 'application_decorator.rb', 'app/decorators/application_decorator.rb'
+
+      end
+    end
+  end
+end

data/lib/generators/deckorator/install/templates/application_decorator.rb

@@ -0,0 +1,9 @@
+class ApplicationDecorator
+  include Deckorator::Delegator
+
+  attr_accessor :decorated_object
+
+  def initialize(object)
+    @decorated_object = object
+  end
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: deckorator
+version: !ruby/object:Gem::Version
+  version: 0.1.0.beta1
+platform: ruby
+authors:
+- John Otander
+- Jake Mays
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-12-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: Lightweight decorators using plain old Ruby objects.
+email:
+- johnotander@gmail.com
+- jake.m.mays@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
+- deckorator.gemspec
+- lib/deckorator.rb
+- lib/deckorator/delegator.rb
+- lib/deckorator/finder.rb
+- lib/deckorator/version.rb
+- lib/generators/deckorator/decorator/USAGE
+- lib/generators/deckorator/decorator/decorator_generator.rb
+- lib/generators/deckorator/decorator/templates/decorator.rb
+- lib/generators/deckorator/install/USAGE
+- lib/generators/deckorator/install/install_generator.rb
+- lib/generators/deckorator/install/templates/application_decorator.rb
+homepage: https://github.com/johnotander/deckorator
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Lightweight decorators using plain old Ruby objects.
+test_files: []