tramway 0.1.0 → 0.1.1

data/app/decorators/tramway/user_decorator.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+class Tramway::UserDecorator < Tramway::ApplicationDecorator
+  class << self
+    def collections
+      [:all]
+    end
+
+    def list_attributes
+      [:email]
+    end
+
+    def show_attributes
+      %i[email first_name last_name phone role created_at updated_at credential_text]
+    end
+
+    if defined? Tramway::Conference
+      def show_associations
+        [:social_networks]
+      end
+    end
+  end
+
+  decorate_association :social_networks, as: :record if defined? Tramway::Conference
+
+  delegate_attributes :first_name, :last_name, :email, :phone, :role, :created_at, :updated_at, :admin?
+
+  def name
+    "#{object&.first_name} #{object&.last_name}"
+  end
+
+  def credential_text
+    content_tag(:pre) do
+      id = "credential_text_#{object.id}"
+
+      concat(content_tag(:span, id: id) do
+        text = "URL: #{ENV['PROJECT_URL']}\n"
+        text += "Email: #{object.email}\n"
+        "#{text}Password: "
+      end)
+
+      concat(content_tag(:br))
+
+      concat copy_to_clipboard id
+    end
+  end
+
+  alias title name
+end

data/app/forms/admin/tramway/user_form.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+class Admin::Tramway::UserForm < ::Tramway::ApplicationForm
+  self.model_class = Tramway::User
+
+  properties :email, :password, :first_name, :last_name, :role, :phone
+
+  # fix me
+  unless model_class.columns_hash['project_id'].present?
+    validates :email, email: true, uniqueness: true,
+      on: :destroy
+  end
+
+  def initialize(object)
+    super(object).tap do
+      form_properties email: :string,
+        password: :string,
+        first_name: :string,
+        last_name: :string,
+        phone: :string,
+        role: :default
+    end
+  end
+end

data/app/forms/tramway/application_form.rb

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+
+class Tramway::ApplicationForm
+  include Tramway::ApplicationForms::AssociationObjectHelpers
+  include Tramway::ApplicationForms::ConstantObjectActions
+  include Tramway::ApplicationForms::PropertiesObjectHelper
+  include Tramway::ApplicationForms::ObjectHelpers
+  include Tramway::ApplicationForms::SubmitHelper
+
+  attr_accessor :submit_message
+
+  def initialize(object = nil)
+    tap do
+      @object = object
+      @@model_class = object.class
+      @@enumerized_attributes = object.class.try :enumerized_attributes
+      @@associations ||= []
+
+      self.class.full_class_name_associations&.each do |association, class_name|
+        define_association_method association, class_name
+      end
+
+      delegating object
+    end
+  end
+
+  def model_name
+    @@model_class.model_name
+  end
+
+  def associations
+    @@associations
+  end
+
+  class << self
+    include Tramway::ApplicationForms::AssociationClassHelpers
+    include Tramway::ApplicationForms::ConstantClassActions
+    include Tramway::ApplicationForms::Frontend
+
+    delegate :defined_enums, to: :model_class
+
+    def properties(*props)
+      props.each { |prop| property prop }
+    end
+
+    def property(prop)
+      @@properties ||= []
+      @@properties << prop
+      delegate prop, to: :model
+      define_method("#{prop}=") do |value|
+        model.send "#{prop}=", value
+      end
+    end
+
+    def association(property)
+      properties property
+      @@associations = ((defined?(@@associations) && @@associations) || []) + [property]
+    end
+
+    def full_class_name_associations
+      @@associations&.reduce({}) do |hash, association|
+        options = @@model_class.reflect_on_all_associations(:belongs_to).select do |a|
+          a.name == association.to_sym
+        end.first&.options
+        add_polymorphic_association hash, association, options
+      end
+    end
+
+    def add_polymorphic_association(hash, association, options)
+      if options&.dig(:polymorphic)
+        hash.merge association => @@model_class.send("#{association}_type").values
+      elsif options
+        hash.merge(association => (options[:class_name] || association.to_s.camelize).constantize)
+      else
+        hash
+      end
+    end
+
+    def full_class_name_association(association_name)
+      full_class_name_associations[association_name]
+    end
+
+    def reflect_on_association(*args)
+      @@model_class.reflect_on_association(*args)
+    end
+
+    def enumerized_attributes
+      @@enumerized_attributes
+    end
+
+    def model_class
+      if defined?(@@model_class) && @@model_class
+        @@model_class
+      else
+        model_class_name ||= name.to_s.sub(/Form$/, '')
+        begin
+          @@model_class = model_class_name.constantize
+        rescue StandardError
+          Tramway::Error.raise_error :tramway, :application_form, :model_class, :there_is_not_model_class,
+            name: name, model_class_name: model_class_name
+        end
+      end
+    end
+
+    def model_class=(name)
+      @@model_class = name
+    end
+
+    def validates(attribute, **options)
+      if !defined?(@@model_class) || @@model_class.nil?
+        Tramway::Error.raise_error(:tramway, :application_form, :validates, :you_need_to_set_model_class)
+      end
+      @@model_class.validates attribute, **options
+    end
+  end
+
+  private
+
+  def collecting_associations_errors
+    @@associations.each do |association|
+      model.send("#{association}=", send(association)) if errors.details[association] == [{ error: :blank }]
+    end
+  end
+end

data/app/forms/tramway/application_forms/association_class_helpers.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Tramway::ApplicationForms::AssociationClassHelpers
+  def associations(*properties)
+    properties.each { |property| association property }
+  end
+end

data/app/forms/tramway/application_forms/association_object_helpers.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Tramway::ApplicationForms::AssociationObjectHelpers
+  def define_association_method(association, class_name)
+    if class_name.is_a? Array
+      define_polymorphic_association association
+    else
+      self.class.send(:define_method, "#{association}=") do |value|
+        model.send "#{association}_id=", value
+        model.send "#{association}=", class_name.find(value)
+      end
+    end
+  end
+
+  def define_polymorphic_association(association)
+    self.class.send(:define_method, "#{association}=") do |value|
+      if value.present?
+        if association_class(value).nil?
+          Tramway::Error.raise_error :tramway, :application_form, :initialize, :polymorphic_class_is_nil,
+            association_name: association
+        else
+          model.send "#{association}=", association_class(value).find(value.split('_')[-1])
+          send "#{association}_type=", association_class(value).to_s
+        end
+      end
+    end
+  end
+
+  private
+
+  def association_class(value)
+    association_class_object = value.split('_')[0..-2].join('_').camelize
+    association_class_object = association_class_object.constantize if association_class_object.is_a? String
+    association_class_object
+  end
+end

data/app/forms/tramway/application_forms/constant_class_actions.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Tramway::ApplicationForms::ConstantClassActions
+  def validation_group_class
+    ActiveModel
+  end
+end

data/app/forms/tramway/application_forms/constant_object_actions.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Tramway::ApplicationForms::ConstantObjectActions
+  def delegating(object)
+    %i[to_key errors].each { |method| self.class.send(:define_method, method) { object.send method } }
+  end
+
+  def build_errors; end
+
+  def attributes
+    properties.reduce({}) do |hash, property|
+      value = if model.respond_to? :values
+                model.values[property.first.to_s]
+              else
+                model.send(property.first.to_s)
+              end
+      hash.merge! property.first => value
+    end
+  end
+end

data/app/forms/tramway/application_forms/frontend.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Tramway::ApplicationForms::Frontend
+  def react_component(on: false)
+    @react_component = on
+  end
+
+  def react_component?
+    @react_component ||= false
+    @react_component
+  end
+end

data/app/forms/tramway/application_forms/object_helpers.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Tramway::ApplicationForms::ObjectHelpers
+  def to_model
+    self
+  end
+
+  def persisted?
+    model.id.nil?
+  end
+
+  def model
+    @object
+  end
+end

data/app/forms/tramway/application_forms/properties_object_helper.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Tramway::ApplicationForms::PropertiesObjectHelper
+  def form_properties(**args)
+    @form_properties = args
+  end
+
+  def properties
+    @form_properties ||= {}
+    yaml_config_file_path = Rails.root.join('app', 'forms', "#{self.class.name.underscore}.yml")
+
+    return @form_properties unless File.exist? yaml_config_file_path
+
+    @form_properties.deep_merge YAML.load_file(yaml_config_file_path).deep_symbolize_keys
+  end
+end

data/app/forms/tramway/application_forms/submit_helper.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Tramway::ApplicationForms::SubmitHelper
+  def submit(params)
+    if params
+      params.each { |key, value| send("#{key}=", value) }
+      result = save
+      result.tap do
+        collecting_associations_errors unless result
+      end
+    else
+      Tramway::Error.raise_error(:tramway, :application_form, :submit, :params_should_not_be_nil)
+    end
+  end
+
+  def save
+    model.save
+  rescue ArgumentError => e
+    Tramway::Error.raise_error :tramway, :application_form, :save, :argument_error, message: e.message
+  rescue StandardError => e
+    raise e unless e.try :name
+
+    Tramway::Error.raise_error :tramway, :application_form, :save, :looks_like_you_have_method,
+      method_name: e.name.to_s.gsub('=', ''), model_class: model.class, class_name: self.class
+  end
+end

data/app/forms/tramway/extendable_form.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+class Tramway::ExtendableForm
+  class << self
+    include Tramway::ExtendableFormsHelpers::ClassBuilder
+
+    def new(name, simple_properties: {}, **more_properties)
+      if Object.const_defined? name
+        name.constantize
+      else
+        build_form_class name, simple_properties, more_properties
+      end
+    end
+  end
+end

data/app/forms/tramway/extendable_forms_helpers/class_builder.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Tramway::ExtendableFormsHelpers::ClassBuilder
+  def build_form_class(name, simple_properties, more_properties)
+    Object.const_set(name, Class.new(::Tramway::ApplicationForm) do
+      properties(*simple_properties.keys) if simple_properties.keys.any?
+
+      include Tramway::ExtendableFormsHelpers::Submit::ObjectHelpers
+      include Tramway::ExtendableFormsHelpers::Validators
+      extend Tramway::ExtendableFormsHelpers::Submit::ClassHelpers
+      extend Tramway::ExtendableFormsHelpers::PropertiesHelper
+      extend Tramway::ExtendableFormsHelpers::MorePropertiesHelper
+      extend Tramway::ExtendableFormsHelpers::IgnoredPropertiesHelper
+
+      define_submit_method simple_properties, more_properties
+      define_properties_method simple_properties, more_properties
+      define_ignored_properties_method
+
+      more_properties.each do |property|
+        define_property_method property[0]
+
+        case property[1][:object].field_type
+        when 'file'
+          field = property[1][:object]
+          define_file_property_assignment_method property, field
+        else
+          # next unless property[1][:validates].present?
+
+          define_assignment_method property
+        end
+      end
+    end)
+  end
+end

data/app/forms/tramway/extendable_forms_helpers/ignored_properties_helper.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Tramway::ExtendableFormsHelpers::IgnoredPropertiesHelper
+  def define_ignored_properties_method
+    define_method :jsonb_ignored_properties do |properties|
+      properties.map do |property|
+        property[0].to_s if property[1][:object].field_type == 'file'
+      end.compact
+    end
+  end
+end

data/app/forms/tramway/extendable_forms_helpers/more_properties_helper.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Tramway::ExtendableFormsHelpers::MorePropertiesHelper
+  def define_property_method(property_name)
+    define_method property_name do
+      model.values[property_name] if model.values
+    end
+  end
+
+  def define_assignment_method(property)
+    define_method "#{property[0]}=" do |value|
+      if property[1][:validates].present?
+        property[1][:validates].each do |pair|
+          make_validates property[0], pair, value
+        end
+      else
+        model.values.merge property[0] => value
+      end
+    end
+  end
+
+  def define_file_property_assignment_method(property, field)
+    define_method "#{property[0]}=" do |value|
+      file_instance = property[1][:association_model].find_or_create_by(
+        "#{model.class.name.underscore}_id" => model.id, "#{field.class.name.underscore}_id" => field.id
+      )
+      file_instance.file = value
+      file_instance.save!
+    end
+  end
+end

data/app/forms/tramway/extendable_forms_helpers/properties_helper.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Tramway::ExtendableFormsHelpers::PropertiesHelper
+  def define_properties_method(simple_properties, more_properties)
+    define_method 'properties' do
+      hash = simple_properties.each_with_object({}) do |property, h|
+        h.merge! property[0] => property[1] unless model.class.state_machines_names.include?(property[0])
+      end
+      more_properties.reduce(hash) do |h, property|
+        h.merge! property[0] => {
+          extended_form_property: property[1][:object]
+        }
+      end
+    end
+  end
+end

data/app/forms/tramway/extendable_forms_helpers/submit/class_helpers.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Tramway::ExtendableFormsHelpers::Submit::ClassHelpers
+  def define_submit_method(simple_properties, more_properties)
+    define_method 'submit' do |params|
+      model.values ||= {}
+      extended_params = extended(simple_properties, more_properties, params)
+      every_attribute_set params
+      model.values = extended_params.reduce(model.values) do |hash, (key, value)|
+        hash.merge! key => value
+      end
+
+      return unless model.errors.empty?
+
+      save_in_submit params
+    end
+  end
+end

data/app/forms/tramway/extendable_forms_helpers/submit/object_helpers.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Tramway::ExtendableFormsHelpers::Submit::ObjectHelpers
+  def extended(simple_properties, more_properties, params)
+    params.except(*simple_properties.keys).except(*jsonb_ignored_properties(more_properties)).permit!.to_h
+  end
+
+  def every_attribute_set(params)
+    params.each do |key, value|
+      method_name = "#{key}="
+      send(method_name, value) if respond_to?(method_name)
+    end
+  end
+
+  def save_in_submit(_params)
+    result = save
+    result.tap do
+      collecting_associations_errors unless result
+    end
+  end
+end

data/app/forms/tramway/extendable_forms_helpers/validators.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Tramway::ExtendableFormsHelpers::Validators
+  def make_validates(property_name, validation, value)
+    case validation[0].to_s
+    when 'presence'
+      presence_validator property_name, validation, value
+    when 'inclusion'
+      inclusion_validator property_name, validation, value
+    end
+  end
+
+  def presence_validator(property_name, validation, value)
+    validator_object = PresenceValidator.new(attributes: :not_blank)
+    return if validation[1] == 'false'
+    return if validation[1] == 'true' && validator_object.send(:valid?, value)
+
+    model.errors.add(
+      property_name,
+      I18n.t(
+        "activerecord.errors.models.#{model.class.name.underscore}.attributes.default.#{validation[0]}",
+        value: value
+      )
+    )
+  end
+
+  def inclusion_validator(property_name, validation, value)
+    in_array = validation[1][:in]
+
+    return if value.in? in_array
+
+    model.errors.add(
+      property_name,
+      I18n.t(
+        "activerecord.errors.models.#{model.class.name.underscore}.attributes.default.#{validation[0]}",
+        value: value
+      )
+    )
+  end
+end

data/app/forms/tramway/extended_application_form.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+class Tramway::ExtendedApplicationForm < Tramway::ApplicationForm
+  class << self
+    def properties(*args)
+      @@extendable_properties ||= []
+      @@extendable_properties += args
+      super(*args)
+    end
+  end
+
+  def initialize(model)
+    @@extendable_properties.each do |prop|
+      next if model.respond_to? prop
+
+      model.class.define_method prop do
+      end
+      model.class.define_method "#{prop}=" do |value|
+      end
+    end
+    super
+  end
+end

data/app/forms/tramway/form_creator.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class Tramway::FormCreator
+  def self.create_form_class
+    raise 'Please, implement `create_form_class` for your class'
+  end
+end

data/app/forms/tramway/session_form.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+class Tramway::SessionForm < Tramway::ApplicationForm
+  properties :email
+  attr_accessor :password
+
+  def initialize(object)
+    object = Tramway::User.new unless object.present?
+
+    super
+  end
+
+  def validate(params)
+    (add_wrong_email_or_password_error && return) if model.new_record?
+
+    (!model.new_record? && model.authenticate(params[:password])).tap do |result|
+      add_wrong_email_or_password_error unless result
+    end
+  end
+
+  private
+
+  def add_wrong_email_or_password_error
+    errors.add(:email, I18n.t('errors.wrong_email_or_password'))
+  end
+end

data/app/helpers/tramway/actions_helper.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Tramway::ActionsHelper
+  def create_is_available?(model_class)
+    Tramway.action_is_available?(
+      nil,
+      project: (@application_engine || @application.name),
+      model_name: model_class,
+      role: current_user.role,
+      action: :create
+    )
+  end
+
+  def update_is_available?(object)
+    Tramway.action_is_available?(
+      object,
+      project: (@application_engine || @application.name),
+      model_name: object.model.class.name,
+      role: current_user.role,
+      action: :update
+    )
+  end
+
+  def destroy_is_available?(object)
+    Tramway.action_is_available?(
+      object,
+      project: (@application_engine || @application.name),
+      model_name: object.model.class.name,
+      role: current_user.role,
+      action: :destroy
+    )
+  end
+
+  # delete_button is in smart-buttons gem
+
+  def edit_button(url:, button_options:, &block)
+    link_to(url, **button_options, &block)
+  end
+
+  def habtm_destroy_is_available?(association_object, main_object)
+    main_model_name = main_object.model.class.to_s.underscore.pluralize
+
+    Tramway.forms&.include?("#{main_model_name}/remove_#{association_object.model.class.to_s.underscore}")
+  end
+end

data/app/helpers/tramway/additional_buttons_builder.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Tramway::AdditionalButtonsBuilder
+  def build_button(button)
+    options = button[:options] || {}
+    style = 'margin-right: 8px'
+    concat(link_to(button[:url], method: button[:method], class: "btn btn-#{button[:color]} btn-xs", style: style,
+                                 **options) do
+             button[:inner]&.call
+           end)
+  end
+end