rails-add_ons 0.2.0

data/app/controllers/api/service_controller/base.rb

@@ -0,0 +1,73 @@
+module Api
+  module ServiceController
+    class Base < ::ApiController
+      module RestActions
+        extend ActiveSupport::Concern
+
+        included do
+          include ActionController::MimeResponds
+
+          respond_to :json
+          
+          if respond_to?(:before_action)
+            before_action :initialize_service_for_create, only: [:create]
+          else
+            before_filter :initialize_service_for_create, only: [:create]
+          end
+        end
+
+        def create
+          @result = @service.perform
+          respond_to do |format|
+            if @result.success?
+              format.json { render json: serialize_result(@result), status: :created }
+            else
+              format.json { render json: { errors: serialize_errors(@result.errors) }, status: 422 }
+            end
+          end
+        end
+
+        private
+
+        def initialize_service_for_create
+          # In rails 5 permitted_params is an instance of ActionController::Parameters.
+          # Stragely, when calling #delete on it, it does not delete the key, so we have
+          # to transform it into a hash first. 
+          params_hash = permitted_params.try(:to_h).presence || permitted_params
+          
+          options = params_hash.try(:delete, :options) || {}
+          @service = service_class.new(params_hash, options)
+        end
+
+        def permitted_params
+          raise "not implemented"
+        end
+      end
+
+      module Service
+        extend ActiveSupport::Concern
+
+        def service_class
+          self.class.service_class
+        end
+      end
+
+      module Serialization
+        private
+
+        def serialize_result(result)
+          result.as_json
+        end
+
+        def serialize_errors(errors)
+          errors
+        end
+      end
+
+      include RestActions
+      include Service
+      include Serialization
+      include ApiControllerConcerns::ExceptionHandling
+    end
+  end
+end

data/app/controllers/rails/add_ons/widgets_controller.rb

@@ -0,0 +1,10 @@
+module Rails
+  module AddOns
+    class WidgetsController < ApplicationController
+      def remote_render
+        widget_name, action = *params[:name].split("#")
+        render plain: widget_name.camelize.constantize.new(view_context).render(action)
+      end
+    end
+  end
+end

data/app/controllers/resources_controller/base.rb

@@ -0,0 +1,180 @@
+module ResourcesController
+  class Base < ::FrontendController
+    layout 'rails/add_ons/application'
+
+    module RestActions
+      extend ActiveSupport::Concern
+
+      included do
+        include ActionController::MimeResponds
+
+        respond_to :html
+        responders :flash
+
+        if respond_to?(:before_action)
+          before_action :load_collection, only: [:index]
+          before_action :load_resource, only: [:show, :edit, :destroy, :update]
+          before_action :initialize_resource, only: [:new]
+          before_action :initialize_resource_for_create, only: [:create]
+        else
+          before_filter :load_collection, only: [:index]
+          before_filter :load_resource, only: [:show, :edit, :destroy, :update]
+          before_filter :initialize_resource, only: [:new]
+          before_filter :initialize_resource_for_create, only: [:create]
+        end
+      end
+
+      def index; end
+      def new; end
+      def show; end
+      def edit; end
+
+      def update
+        if Rails::VERSION::MAJOR < 4
+          @resource.update_attributes(permitted_params)
+        else
+          @resource.update(permitted_params)
+        end
+        respond_with @resource
+      end
+
+      def destroy
+        @resource.destroy
+        respond_with @resource
+      end
+
+      def create
+        @resource.save
+        respond_with @resource
+      end
+
+      private
+
+      def after_create_location
+        ->(controller) { resource_path(@resource) }
+      end
+
+      def load_collection_scope
+        resource_class
+      end
+      def load_collection
+        @collection = load_collection_scope.all
+      end
+
+      def load_resource_scope
+        resource_class
+      end
+      def load_resource
+        @resource = load_resource_scope.find(params[:id])
+      end
+
+      def initialize_resource
+        @resource = resource_class.new
+      end
+
+      def initialize_resource_for_create
+        @resource = resource_class.new(permitted_params)
+      end
+
+      def permitted_params
+        raise "not implemented"
+      end
+    end
+
+    module Resources
+      extend ActiveSupport::Concern
+
+      included do
+        helper_method :resource_class
+      end
+
+      def resource_class
+        self.class.resource_class
+      end
+    end
+
+    module RestResourceUrls
+      extend ActiveSupport::Concern
+
+      included do
+        helper_method :new_resource_path
+        helper_method :collection_path
+        helper_method :resource_path
+        helper_method :edit_resource_path
+      end
+
+      private
+
+      def new_resource_path
+        url_for(action: :new, only_path: true)
+      end
+
+      def collection_path
+        url_for(action: :index, only_path: true)
+      end
+
+      def resource_path(resource)
+        url_for(action: :show, id: resource, only_path: true)
+      end
+
+      def edit_resource_path(resource)
+        url_for(action: :edit, id: resource, only_path: true)
+      end
+    end
+
+    module ResourceInflections
+      extend ActiveSupport::Concern
+
+      included do
+        helper_method :inflections
+      end
+
+      private
+
+      def inflections
+        {
+          resource_name: resource_class.model_name.human(count: 1),
+          collection_name: resource_class.model_name.human(count: 2)
+        }
+      end
+    end
+
+    module LocationHistory
+      extend ActiveSupport::Concern
+
+      included do
+        if respond_to?(:before_action)
+          before_action :store_location
+        else
+          before_filter :store_location
+        end
+      end
+
+      private
+
+      def store_location
+        truncate_location_history(9)
+        location_history[Time.zone.now] = request.referer
+      end
+
+      def location_history
+        session[:location_history] ||= {}
+      end
+
+      def last_location
+        location_history.sort.last.try(:last)
+      end
+
+      def truncate_location_history(count = 0)
+        return if location_history.size <= count
+        session[:location_history] = session[:location_history].sort.last(count).to_h
+      end
+    end
+
+    include RestActions
+    include Resources
+    include RestResourceUrls
+    include ResourceInflections
+    include LocationHistory
+  end
+end

data/app/controllers/service_controller/base.rb

@@ -0,0 +1,135 @@
+module ServiceController
+  class Base < ::FrontendController
+    layout 'rails/add_ons/application'
+
+    module RestActions
+      extend ActiveSupport::Concern
+
+      included do
+        include ActionController::MimeResponds
+        
+        respond_to :html
+        responders :flash
+        
+        if respond_to?(:before_action)
+          before_action :initialize_service, only: [:new]
+          before_action :initialize_service_for_create, only: [:create]
+        else
+          before_filter :initialize_service, only: [:new]
+          before_filter :initialize_service_for_create, only: [:create]
+        end
+      end
+
+
+      def new; end
+      
+      def create
+        @response = @resource.perform
+        if @response.success?
+          render :create
+        else
+          render :new
+        end
+      end
+
+      private
+
+      def initialize_service
+        @resource = service_class.new
+      end
+
+      def initialize_service_for_create
+        @resource = service_class.new(permitted_params)
+      end
+
+      def permitted_params
+        raise "not implemented"
+      end
+    end
+
+    module Service
+      extend ActiveSupport::Concern
+      
+      included do
+        helper_method :service_class
+      end
+
+      def service_class
+        self.class.service_class
+      end
+    end
+
+    module RestResourceUrls
+      extend ActiveSupport::Concern
+
+      included do
+        helper_method :new_resource_path
+        helper_method :create_resource_path
+      end
+
+      private
+
+      def new_resource_path
+        url_for(action: :new, only_path: true)
+      end
+
+      def create_resource_path
+        url_for(action: :create, only_path: true)
+      end
+    end
+
+    module ResourceInflections
+      extend ActiveSupport::Concern
+
+      included do
+        helper_method :inflections
+      end
+
+      private
+
+      def inflections
+        {
+          service_name: service_class.model_name.human
+        }
+      end
+    end
+
+    module LocationHistory
+      extend ActiveSupport::Concern
+
+      included do
+        if respond_to?(:before_action)
+          before_action :store_location
+        else
+          before_filter :store_location
+        end
+      end
+
+      private
+
+      def store_location
+        truncate_location_history(9)
+        location_history[Time.zone.now] = request.referer
+      end
+
+      def location_history
+        session[:location_history] ||= {}
+      end
+
+      def last_location
+        location_history.sort.last.try(:last)
+      end
+
+      def truncate_location_history(count = 0)
+        return if location_history.size <= count
+        session[:location_history] = session[:location_history].sort.last(count).to_h
+      end
+    end
+
+    include Service
+    include RestActions
+    include RestResourceUrls
+    include ResourceInflections
+    include LocationHistory
+  end
+end

data/app/extensions/object_extensions.rb

@@ -0,0 +1,8 @@
+module ObjectExtensions
+  def try_all(*methods)
+    methods.map(&:to_sym).each do |method|
+      next unless respond_to?(method)
+      return send(method)
+    end
+  end
+end

data/app/helpers/rails/add_ons/table_helper.rb

@@ -0,0 +1,50 @@
+module Rails
+  module AddOns
+    module TableHelper
+      def collection_table(options = {}, &block)
+        Component::CollectionTable.new(self, options, &block).perform
+      end
+
+      def resource_table(options = {}, &block)
+        Component::ResourceTable.new(self, options, &block).perform
+      end
+
+      def sort_link(column_name, title, options = {})
+        return title if options === false
+        SortLink.new(self, column_name, title, options).perform
+      end
+
+      class SortLink
+        def initialize(view_context, column_name, title, options)
+          default_options = {}
+
+          if options === true
+            @options = default_options
+          else
+            @options = options.reverse_merge(default_options)
+          end
+
+          @view_context = view_context
+          @column_name  = column_name
+          @title        = title
+
+          if h.params[:sort_direction].present?
+            @sort_direction = (h.params[:sort_direction].to_sym == :asc) ? :desc : :asc
+          else
+            @sort_direction = :asc
+          end
+        end
+
+        def perform
+          h.link_to(@title, h.url_for(sort_by: @column_name, sort_direction: @sort_direction))
+        end
+
+        private
+
+        def h
+          @view_context
+        end
+      end
+    end
+  end
+end

data/app/helpers/rails/add_ons/widget_helper.rb

@@ -0,0 +1,10 @@
+module Rails
+  module AddOns
+    module WidgetHelper
+      def render_widget(name, options = {}, &block)
+        klass = "#{name}_widget".camelize.classify.constantize
+        klass.new(self, options, &block).render
+      end
+    end
+  end
+end

data/app/parsers/api/resources_controller/condition_parser.rb

@@ -0,0 +1,65 @@
+module Api
+  module ResourcesController
+    class ConditionParser
+      OPERATOR_MAP = {
+        gt:       :>,
+        gt_or_eq: :>=,
+        eq:       :'=',
+        not_eq:   :'<>',
+        lt_or_eq: :<=,
+        lt:       :<
+      }
+
+      def initialize(field, condition)
+        # @condition = { field => condition }
+        @field, @condition = field, condition
+      end
+
+      def condition_statement
+        build_condition_statement(@field, @condition)
+      end
+
+      private
+
+      def build_condition_statement(parent_key, condition, nested = false)
+        if is_a_condition?(parent_key) && !nested
+          column, operator = extract_column_and_operator(parent_key)
+          ["#{column} = ?", condition]
+        else
+          if nested
+            column = extract_column(parent_key)
+            { column => condition }
+          else
+            { parent_key => build_condition_statement(condition.first[0], condition.first[1], true) }
+          end
+        end
+      end
+
+      def is_a_condition?(obj)
+        !!extract_operator(obj)
+      end
+
+      def extract_operator(obj)
+        string = obj.to_s
+        operator_map.each do |key, value|
+          return value if string.end_with?("(#{key})")
+        end
+        nil
+      end
+
+      def extract_column(obj)
+        obj.to_s.split("(").first
+      end
+
+      def extract_column_and_operator(string)
+        if string =~ /([a-z_]{1,})\(([a-z_]{2,})\)/
+          return $~[1], $~[2]
+        end 
+      end
+
+      def operator_map
+        OPERATOR_MAP
+      end
+    end
+  end
+end

data/app/services/rails/add_ons/service/base.rb

@@ -0,0 +1,156 @@
+module Rails
+  module AddOns
+    module Service
+      class Base
+        include ActiveModel::Model
+
+        def self.attr_accessor(*args)
+          super
+          add_attribute_names(*args)
+        end
+
+        def self.add_attribute_names(*args)
+          args.each do |attr_name|
+            attribute_names << attr_name
+          end
+        end
+
+        def self.attribute_names
+          (@attr_names ||= [])
+        end
+
+        def self.i18n_scope
+          :activerecord
+        end
+
+        def self.call(*args)
+          new(*args).perform
+        end
+
+        def initialize(attributes = {}, options = {}, &block)
+          @options    = options
+          @block      = block
+          @attributes = {}
+          set_attributes(attributes)
+          initialize_result
+          initialize_errors
+          initialize_messages
+          after_initialize
+        end
+
+        private
+
+        module Attributes
+          def set_attributes(attributes)
+            attributes.each do |key, value|
+              send("#{key}=", value)
+            end
+          end
+        end
+
+        include Attributes
+
+        module Callbacks
+          def after_initialize; end
+          def before_perform; end
+          def after_perform; end
+          def before_validation; end
+          def after_validation; end
+          def after_perform; end
+
+          def perform
+            before_validation
+            return perform_result unless valid?
+            after_validation
+            before_perform
+            say "Performing" do
+              _perform
+            end
+            after_perform
+            perform_result
+          end
+        end
+
+        module Resultable
+          private
+
+          def initialize_result
+            @result = result_class.new
+          end
+
+          def perform_result
+            copy_messages_to_result
+            copy_errors_to_result
+            @result
+          end
+
+          def result_class
+            "#{self.class.name}::Result".constantize
+          end
+        end
+
+        module Errors
+          private
+
+          def initialize_errors
+            @errors = ActiveModel::Errors.new(self)
+          end
+
+          def copy_errors_to_result
+            @result.instance_variable_set(:@errors, @errors)
+          end
+
+          def copy_errors_from_to(obj, key_prefix)
+            obj.errors.each do |key, message|
+              @errors.add(key_prefix, message)
+            end
+          end
+        end
+
+        module Messages
+          private
+
+          def initialize_messages
+            @messages = []
+          end
+
+          def say(what, &block)
+            @indent ||= 0
+            if block_given?
+              @indent += 1
+              output "#{output_prefix}#{("  " * @indent)}#{what}..."
+              block_result = yield
+              say_done
+              @indent -= 1
+              block_result
+            else
+              output "#{output_prefix}#{("  " * @indent)}#{what}"
+            end
+          end
+
+          def say_done
+            say "  => Done"
+          end
+
+          def output_prefix
+            "[#{self.class.name}] "
+          end
+
+          def output(what)
+            @messages << what
+            puts what
+          end
+
+          def copy_messages_to_result
+            @result.instance_variable_set(:@messages, @messages)
+          end
+        end
+
+        include Errors
+        include Resultable
+        include Callbacks
+        include Messages
+      end
+    end
+  end
+end

data/app/services/rails/add_ons/service/result/base.rb

@@ -0,0 +1,25 @@
+module Rails
+  module AddOns
+    module Service::Result
+      class Base
+        attr_reader :messages, :errors
+
+        module Succeedable
+          def success?
+            !failed?
+          end
+
+          def failed?
+            @errors.any?
+          end
+
+          def ok?
+            success?
+          end
+        end
+
+        include Succeedable
+      end
+    end
+  end
+end