record_decorator 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 675c2f4d1f9a4bb467068611e3b32a6be1af9349
+  data.tar.gz: adc9b1009f8ec9f184063387f4a7d0ee38345ddf
+SHA512:
+  metadata.gz: 18f58ac7f4c49f1782b59e432cc6d65ac735ea4445174dd6ca04a0c3d9c2bac1a11b8ac5374297ae81eee642ed34e820889610677fa7b9e3431b4fff082b8bd6
+  data.tar.gz: 8e553ed4a317e24b6198bae73a79becd64b07c32d1320ae199e7ed2f0aaa11970e5b25d8311ef298c2dcde36504584a257ae3263ba8eecaf8cae57ab43780ed6

data/.gitignore

@@ -0,0 +1,50 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Aivils Stoss
+
+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,135 @@
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'record_decorator'
+```
+
+## Supported versions ##
+
+* Rails 3.2.x, 4, 5.0
+
+## Supported ORMs ##
+
+ActiveRecord
+
+If Your ORM is not supported be aware codebase is very small.
+It works like this:
+
+```
+@user = User.find(5)
+@user.extend User::AddOns::VeryNice
+```
+Where
+  @user may be the model or another instance of ruby object
+  User::AddOns::VeryNice is module
+
+## Usage
+
+Simple case
+
+```
+#model
+class User < ActiveRecord::Base
+end
+
+# Default decorator
+# Any decorator uses AR model scope
+module User::AddOns::Decorator
+  def email
+    "Email: #{super}"
+  end
+
+  def full_name
+    "#{first_name} #{last_name}"
+  end
+end
+
+# controller must call decorator
+class UsersController < ApplicationController
+  def index
+    @users = Users.all.page(params[:page]).decorate
+  end
+
+  def show
+    @user = User.find(params[:id]).decorate
+  end
+end
+```
+
+Context specific decorators
+```
+#model
+class User < ActiveRecord::Base
+end
+
+# Default decorator
+module User::AddOns::Decorator
+  def full_name
+    "#{first_name} #{last_name}"
+  end
+end
+
+module User::AddOns::Show
+  include User::AddOns::Decorator
+
+  def full_position
+    "#{profile.position}, #{profile.branch}, #{profile.city}"
+  end
+end
+
+module User::AddOns::Step1
+  # add validation for this step
+  def self.extended base
+    base.singleton_class.validates :first_name, :last_name, presence: true
+  end
+
+  # add processing method for this step
+  def process(params, analytic)
+    result = update(permitted_params(params))
+    if result
+      # on success do something
+      analytic.track({user: self, event: 'fill_name'})
+    end
+    result
+  end
+
+  private
+
+  def permitted_params(params)
+    params.require(:user).permit(:first_name, :last_name)
+  end
+end
+
+
+# controller must call decorator
+class UsersController < ApplicationController
+  def index
+    @users = Users.all.page(params[:page]).decorate
+  end
+
+  def show
+    @user = User.find(params[:id]).decorate(:show)
+  end
+
+  def create_step1
+    @user = User.find(params[:id]).decorate(:step1)
+    # method defined in the decorator Step1
+    @user.process(params, @analytic)
+  end
+end
+```
+
+
+## Contributing
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Inspired By
+
+https://github.com/itkrt2y/active_decorator

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: :spec

data/lib/record_decorator.rb

@@ -0,0 +1,2 @@
+require 'record_decorator/version'
+require 'record_decorator/railtie'

data/lib/record_decorator/decorate.rb

@@ -0,0 +1,21 @@
+require 'record_decorator/decorator'
+
+module RecordDecorator
+  module AssociationDecorate
+    def target
+      RecordDecorator::Decorator.decorate_association(owner, super)
+    end
+  end
+
+  module BaseDecorate
+    def decorate(name = nil, options = {})
+      RecordDecorator::Decorator.decorate(self, name, options)
+    end
+  end
+
+  module RelationDecorate
+    def decorate(name = nil, options = {})
+      RecordDecorator::Decorator.decorate(self, name, options)
+    end
+  end
+end

data/lib/record_decorator/decorator.rb

@@ -0,0 +1,83 @@
+module RecordDecorator
+  class Decorator
+    class << self
+      def decorate_association(owner, target)
+        if owner.respond_to?(:__record_decorator)
+          decorate target, owner.__record_decorator.name, owner.__record_decorator.options
+        else
+          target
+        end
+      end
+
+      def decorate(target, name = nil, options = {})
+        return target if defined?(Jbuilder) && Jbuilder === target
+        return target if target.nil?
+
+        if target.is_a?(ActiveRecord::Base)
+          if target.respond_to?(:__record_decorator)
+            return target
+          else
+            target.extend RecordDecorator::Marker
+            target.__record_decorator = OpenStruct.new(name: name, options: options)
+          end
+        end
+
+        if target.is_a?(Array)
+          target.each do |record|
+            decorate record, name
+          end
+        elsif defined?(ActiveRecord) && target.is_a?(ActiveRecord::Relation) && !target.is_a?(RecordDecorator::RelationDecorator)
+          target.extend RecordDecorator::Marker
+          target.__record_decorator = OpenStruct.new(name: name, options: options)
+          # don't call each nor to_a immediately
+          if target.respond_to?(:records)
+            # Rails 5.0
+            target.extend RecordDecorator::RelationDecorator
+          else
+            # Rails 3.x and 4.x
+            target.extend RecordDecorator::RelationDecoratorLegacy
+          end
+        else
+          decorator = decorator_for target, name
+          puts "Found decorator: '#{decorator}'"
+          return target unless decorator
+          target.extend decorator unless target.is_a? decorator
+        end
+      end
+
+      private
+
+      def decorator_for(target, name)
+        module_name = "#{target.class.name}::AddOns::#{name ? name.to_s.camelize : 'Decorator'}"
+        puts "Search for decorator: '#{module_name}'"
+        _const_get(module_name)
+      end
+
+      def _const_get(const)
+        const.safe_constantize
+      end
+    end
+  end
+
+  module Marker
+    def self.extended base
+      base.singleton_class.send(:attr_accessor, :__record_decorator)
+    end
+  end
+
+  module RelationDecoratorLegacy
+    def to_a
+      super.tap do |arr|
+        RecordDecorator::Decorator.decorate arr, __record_decorator.name,  __record_decorator.options
+      end
+    end
+  end
+
+  module RelationDecorator
+    def records
+      super.tap do |arr|
+        RecordDecorator::Decorator.decorate arr, __record_decorator.name,  __record_decorator.options
+      end
+    end
+  end
+end

data/lib/record_decorator/railtie.rb

@@ -0,0 +1,12 @@
+require 'rails'
+require 'record_decorator/decorate'
+
+module RecordDecorator
+  class Railtie < ::Rails::Railtie
+    initializer 'record_decorator' do
+      ActiveRecord::Associations::Association.prepend RecordDecorator::AssociationDecorate
+      ActiveRecord::Base.include RecordDecorator::BaseDecorate
+      ActiveRecord::Relation.include RecordDecorator::RelationDecorate
+    end
+  end
+end

data/lib/record_decorator/version.rb

@@ -0,0 +1,3 @@
+module RecordDecorator
+  VERSION = '0.0.1'
+end

data/record_decorator.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'record_decorator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "record_decorator"
+  spec.version       = RecordDecorator::VERSION
+  spec.author        = "Aivils Stoss"
+  spec.email         = "aivils@ithouse.lv"
+
+  spec.summary       = "decorate active record and his associations with anything"
+  spec.description   = ""
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rails", ">= 3.2"
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: record_decorator
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Aivils Stoss
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-09-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !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'
+description: ''
+email: aivils@ithouse.lv
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/record_decorator.rb
+- lib/record_decorator/decorate.rb
+- lib/record_decorator/decorator.rb
+- lib/record_decorator/railtie.rb
+- lib/record_decorator/version.rb
+- record_decorator.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+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.6.10
+signing_key: 
+specification_version: 4
+summary: decorate active record and his associations with anything
+test_files: []