eitil 1.4.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d2b711724f69a784e0bc3c374d20fc69a333d7aaf13d14b385eda5e4555f7460
-  data.tar.gz: 77634b67694ccc4b3491c3109f9f8ce09fb076f7a501bc5bbfee852703b51487
+  metadata.gz: fac708d7cfe133d03e39c0606ca98572f8ca1f2dfb490ca872d68fb49b5f054a
+  data.tar.gz: 0bf381608da0aaeb140e73e1819a2a5b2f155e6157ab326645b8f8378c2f6f54
 SHA512:
-  metadata.gz: 4cdd22e13e5bfb4225187171da7bb0f4fb600c35b72dd007f0bbada16e0d2f349ad97b1c8355aa5e89cd4a6b42b9776027232f278a97aa5e91a2a6bfa5de7922
-  data.tar.gz: f3084558965176db0aceebb82e218b6dde618e57ab6cb6ab768a9b5f9a36d98f657d28967d08ddcfe5928dc8529382a6971bc1a94a4bc179f4e15c32167dceb1
+  metadata.gz: 241e2a5baf494d84d0f2400e06382bbd57d6488b540a68de0eec14c31fe865984dfefff828864e4c816960df303f94f00e4f988c2aec0fc4ce1762b58c156c94
+  data.tar.gz: 1309197e2d0bbea822aa36aaec692ed9e903c053eb48130c9d888ddd19aca7632cf15a78d76ca71de7f0cadb89e16dc28fd3ae0cb4e3eaf78601fea07d183e77

data/eitil_wrapper/README.md

@@ -37,44 +37,6 @@ Callback helper methods are created for use within a model's callbacks. You can
 
 
 
-## EitilWrapper::Decorators
-
-```ruby
-
-require "eitil_wrapper/decorators"
-
-```
-
-The Eitil decorator wrappers help you to standardize the calling of the right decorator method from within your controller action. Basically it provides you with a decorate macro in each controller.
-
-```ruby
-decorate(dec_item, dec_method: nil, dec_class: nil, **dec_kwargs)
-```
-
-- dec_item is the instance that will be decorated
-- dec_method enabled you to set the desired decorator method. If not provided, it will look into the request params: if params["isMobile"] is present it will call .app, if params["isWeb"] is present it will call :app. If neither is provided in the params, it will call the default method :base.
-- dec_class enables you to overwrite the decorator class that will be called. If not provided, the decorator class will be inferred from the instance model's classname (User => UserDecorator).
-- dec_kwargs enables you to provide additional arguments, which will be passed to your decorator method.
-
-
-### Configuration
-
-1. Your decorator classes should inherit from EitilWrapper::ApplicationDecorator.
-2. Your controllers should inherit the module EitilWrapper::ControllerDecorator, through inclusion in a superclass.
-3. If you set controller ivars for each request, you can make them available in your decorators by providing Eitil with the names of your ivars as an array of symbols:
-
-```ruby
-# initializers/eitil.rb
-
-Eitil.set_config do |config|
-  config.controller_ivars = [:user, :env]
-end
-```
-
-
-
-
-
 ## EitilWrapper::Jobs
 
 ```ruby

data/eitil_wrapper/lib/eitil_wrapper.rb

@@ -5,5 +5,4 @@ require "eitil_wrapper/jobs"
 require "eitil_wrapper/records"
 require "eitil_wrapper/routes"
 require "eitil_wrapper/callbacks"
-require "eitil_wrapper/decorators"
 require "eitil_wrapper/request_logger"

data/lib/eitil/version.rb

@@ -1,5 +1,5 @@
 module Eitil
   
-  VERSION = '1.4.1'
+  VERSION = '2.0.0'
   
 end

data/spec/dummy_app/app/controllers/application_controller.rb

@@ -1,5 +1,3 @@
 class ApplicationController < ActionController::Base
 
-  include EitilWrapper::ControllerDecorator
-
 end

data/spec/dummy_app/app/controllers/users_controller.rb

@@ -3,37 +3,6 @@ class UsersController < ApplicationController
   before_action :set_user, only: [:show, :edit, :update, :destroy]
 
 
-  # ---
-  # Tests for EitilWrapper::Decorator
-
-  before_action :set_user, only: [:decorator_a, :decorator_b, :decorator_c, :decorator_d]
-
-  # default
-  def decorator_a
-    hash = decorate(@user)
-    render json: hash
-  end
-
-  # specific dec_method
-  def decorator_b
-    hash = decorate(@user, dec_method: :first_and_last_name)
-    render json: hash
-  end
-
-  # post request, with 'isWeb' and 'isMobile' params
-  def decorator_c
-    hash = decorate(@user)
-    render json: hash
-  end
-
-  # specific dec_class
-  def decorator_d
-    hash = decorate(@user, dec_class: :Application, dec_method: :timestamps)
-    render json: hash
-  end
-
-  # ---
-
 
 
   # GET /users

data/spec/dummy_app/config/routes.rb

@@ -4,9 +4,4 @@ Rails.application.routes.draw do
   resources :addresses
   resources :users
 
-  get  'users/:id/decorator_a' => 'users#decorator_a'
-  get  'users/:id/decorator_b' => 'users#decorator_b'
-  post 'users/:id/decorator_c' => 'users#decorator_c'
-  get  'users/:id/decorator_d' => 'users#decorator_d'
-
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eitil
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Jurriaan Schrofer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-12 00:00:00.000000000 Z
+date: 2021-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -275,9 +275,6 @@ files:
 - eitil_wrapper/lib/eitil_wrapper.rb
 - eitil_wrapper/lib/eitil_wrapper/callbacks.rb
 - eitil_wrapper/lib/eitil_wrapper/callbacks/helper_methods.rb
-- eitil_wrapper/lib/eitil_wrapper/decorators.rb
-- eitil_wrapper/lib/eitil_wrapper/decorators/application_decorator.rb
-- eitil_wrapper/lib/eitil_wrapper/decorators/controller_decorator.rb
 - eitil_wrapper/lib/eitil_wrapper/jobs.rb
 - eitil_wrapper/lib/eitil_wrapper/jobs/new_job.rb
 - eitil_wrapper/lib/eitil_wrapper/jobs/new_job_now.rb
@@ -309,9 +306,6 @@ files:
 - spec/dummy_app/app/controllers/addresses_controller.rb
 - spec/dummy_app/app/controllers/application_controller.rb
 - spec/dummy_app/app/controllers/users_controller.rb
-- spec/dummy_app/app/decorators/address_decorator.rb
-- spec/dummy_app/app/decorators/application_decorator.rb
-- spec/dummy_app/app/decorators/user_decorator.rb
 - spec/dummy_app/app/helpers/addresses_helper.rb
 - spec/dummy_app/app/helpers/application_helper.rb
 - spec/dummy_app/app/helpers/users_helper.rb
@@ -444,7 +438,6 @@ files:
 - spec/eitil_integrate/application_exporter/auto_sum_spec.rb
 - spec/eitil_integrate/application_exporter/initialize_spec.rb
 - spec/eitil_wrapper/callbacks/helper_methods_spec.rb
-- spec/eitil_wrapper/decorators/decorators_spec.rb
 - spec/eitil_wrapper/jobs/single_method_job_spec.rb
 - spec/eitil_wrapper/routes/extended_resources_spec.rb
 - spec/eitil_wrapper/scopes/default_scopes_spec.rb

data/eitil_wrapper/lib/eitil_wrapper/decorators/application_decorator.rb

@@ -1,22 +0,0 @@
-
-require "active_model/railtie"
-
-module EitilWrapper
-  class ApplicationDecorator
-
-    include ActiveModel::Model
-
-    def initialize(attributes={}, **kwargs)      
-      super attributes
-      all_kwargs_to_ivars binding
-    end
-
-    def self.method_missing(method_name, *args, **kwargs)
-      if %i$ web app $.include?(method_name.to_sym)
-        kwargs.any? ? send(:base, *args, **kwargs) : send(:base, *args)
-      end
-      super
-    end
-
-  end
-end

data/eitil_wrapper/lib/eitil_wrapper/decorators/controller_decorator.rb

@@ -1,72 +0,0 @@
-module EitilWrapper
-  module ControllerDecorator
-
-    private
-
-    def decorate(dec_item, dec_method: nil, dec_class: nil, **dec_kwargs)
-      all_args_to_ivars binding
-      set_ivars :dec_class, :decorator, :dec_method
-      send_to_decorator
-
-      rescue NameError => e
-        puts "EitilWrapper::ControllerDecorator => rescuing uninitialised constant #{e.name}, returning the object's default JSON instead."
-        return dec_item.as_json
-    end
-
-    def send_to_decorator
-       @decorator.send(@dec_method, @dec_item)
-     
-      rescue NoMethodError => e       
-        inform_no_method_for_decorator_error
-        @dec_item
-    end
-
-    def inform_no_method_for_decorator_error
-      message = "Warning: NoMethodError for #{@dec_class}##{@dec_method}, returned @dec_item instead."
-      Logger.new("#{Rails.root}/log/decorator_log.log").warn message
-      warn message
-    end
-
-    def set_dec_method
-      @dec_method = @dec_method || derived_dec_method || :base
-    end
-
-    def derived_dec_method
-      return unless respond_to? :params      
-      return :app if @decorator.respond_to?(:app) && params["isMobile"]
-      return :web if @decorator.respond_to?(:web) && params["isWeb"]
-    end
-
-    def set_dec_class
-      @dec_class = @dec_class ? manual_set_dec_class : derived_dec_class
-    end
-
-    def manual_set_dec_class
-      "#{@dec_class}Decorator".constantize
-    end
-
-    def derived_dec_class
-      "#{@dec_item.class.name}Decorator".constantize
-    end
-
-    def set_decorator
-      @dec_class.new **ivars
-    end
-
-    # Converts the controller_ivars, given in your main application's configuration,
-    # into an hash. If no controller_ivars, continue with converting, in order to avoid
-    # issues due to differing data types.
-    def controller_ivars
-      return {} unless Eitil.controller_ivars.any?
-
-      Eitil.controller_ivars.map do |ivar|
-        { ivar => instance_variable_get("@#{ivar.to_s}") }
-      end.inject &:merge
-    end
-
-    def ivars
-       @dec_kwargs.any? ? controller_ivars.merge(@dec_kwargs) : controller_ivars
-    end
-
-  end
-end

data/eitil_wrapper/lib/eitil_wrapper/decorators.rb

@@ -1,3 +0,0 @@
-
-require "eitil_wrapper/decorators/application_decorator"
-require "eitil_wrapper/decorators/controller_decorator"

data/spec/dummy_app/app/decorators/address_decorator.rb

@@ -1,3 +0,0 @@
-class AddressDecorator < ApplicationDecorator
-
-end

data/spec/dummy_app/app/decorators/application_decorator.rb

@@ -1,12 +0,0 @@
-class ApplicationDecorator < EitilWrapper::ApplicationDecorator
-
-  # ---
-  # Tests for EitilWrapper::Decorator
-
-  def timestamps(record)
-    record.slice(:created_at, :updated_at)
-  end
-
-  # ---
-
-end

data/spec/dummy_app/app/decorators/user_decorator.rb

@@ -1,19 +0,0 @@
-class UserDecorator < ApplicationDecorator
-
-  def first_and_last_name(user)
-    user.slice(:first_name, :last_name)
-  end
-
-  def app(user)
-    user.slice(:phone, :email)
-  end
-
-  def web(user)
-    user.slice(:age, :wage)
-  end
-
-  def base(user)
-    user.as_json
-  end
-
-end

data/spec/eitil_wrapper/decorators/decorators_spec.rb

@@ -1,49 +0,0 @@
-
-RSpec.describe "EitilWrapper::Decorators" do
-
-  include Rack::Test::Methods
-
-  let(:user) { User.create(first_name: 'slim', last_name: 'shady') }
-
-  def body(endpoint)
-    @body ||= JSON.parse(get("/users/#{user.id}/#{endpoint}").body)
-  end
-
-  it "should respond to a request" do   
-    response = get "/users/#{user.id}/decorator_a"
-    expect(response).to be_a Rack::MockResponse
-  end
-
-  it "should, by default, return all of a records' columns" do
-    response_keys = body(:decorator_a).keys.map(&:to_sym)
-    table_columns = [:id, :created_at, :updated_at, :first_name, :last_name, :email, :birthday, :phone, :confirmed, :last_sign_in, :age, :wage]
-    expect(table_columns.all? { |column| response_keys.include?(column) }).to be_truthy
-  end
-
-  it "should, if a specific decorator method is passed, return that method's value" do
-    response_keys  = body(:decorator_b).keys.map(&:to_sym)
-    decorator_keys = [:first_name, :last_name]
-    expect(response_keys).to eq decorator_keys
-  end
-
-  it "should, if no decorator method is passed, but param['isMobile'] is present, return the :app method's value" do
-    response       = post "/users/#{user.id}/decorator_c", { "isMobile" => true }
-    response_keys  = JSON.parse(response.body).keys.map(&:to_sym)
-    decorator_keys = [:phone, :email]
-    expect(response_keys).to eq decorator_keys
-  end
-
-  it "should, if no decorator method is passed, but param['isWeb'] is present, return the :web method's value" do
-    response       = post "/users/#{user.id}/decorator_c", { "isWeb" => true }
-    response_keys  = JSON.parse(response.body).keys.map(&:to_sym)
-    decorator_keys = [:age, :wage]
-    expect(response_keys).to eq decorator_keys
-  end
-
-  it "should, if a decorator class is passed, return the value of that class' method" do
-    response_keys  = body(:decorator_d).keys.map(&:to_sym)
-    decorator_keys = [:created_at, :updated_at]
-    expect(response_keys).to eq decorator_keys
-  end
-  
-end