tramway 0.1.0 → 0.1.1

data/lib/tramway/generators/templates/initializers/simple_form_bootstrap.rb

@@ -0,0 +1,133 @@
+# frozen_string_literal: true
+
+SimpleForm.setup do |config|
+  config.error_notification_class = 'alert alert-danger'
+  config.button_class = 'btn btn-default'
+  config.boolean_label_class = nil
+
+  config.wrappers :vertical_form, tag: 'div', class: 'form-group', error_class: 'has-error' do |b|
+    b.use :html5
+    b.use :placeholder
+    b.optional :maxlength
+    b.optional :pattern
+    b.optional :min_max
+    b.optional :readonly
+    b.use :label, class: 'control-label'
+
+    b.use :input, class: 'form-control'
+    b.use :error, wrap_with: { tag: 'span', class: 'help-block' }
+    b.use :hint,  wrap_with: { tag: 'p', class: 'help-block' }
+  end
+
+  config.wrappers :vertical_file_input, tag: 'div', class: 'form-group', error_class: 'has-error' do |b|
+    b.use :html5
+    b.use :placeholder
+    b.optional :maxlength
+    b.optional :readonly
+    b.use :label, class: 'control-label'
+
+    b.use :input
+    b.use :error, wrap_with: { tag: 'span', class: 'help-block' }
+    b.use :hint,  wrap_with: { tag: 'p', class: 'help-block' }
+  end
+
+  config.wrappers :vertical_boolean, tag: 'div', class: 'form-group', error_class: 'has-error' do |b|
+    b.use :html5
+    b.optional :readonly
+
+    b.wrapper tag: 'div', class: 'checkbox' do |ba|
+      ba.use :label_input
+    end
+
+    b.use :error, wrap_with: { tag: 'span', class: 'help-block' }
+    b.use :hint,  wrap_with: { tag: 'p', class: 'help-block' }
+  end
+
+  config.wrappers :vertical_radio_and_checkboxes, tag: 'div', class: 'form-group', error_class: 'has-error' do |b|
+    b.use :html5
+    b.optional :readonly
+    b.use :label, class: 'control-label'
+    b.use :input
+    b.use :error, wrap_with: { tag: 'span', class: 'help-block' }
+    b.use :hint,  wrap_with: { tag: 'p', class: 'help-block' }
+  end
+
+  config.wrappers :horizontal_form, tag: 'div', class: 'form-group', error_class: 'has-error' do |b|
+    b.use :html5
+    b.use :placeholder
+    b.optional :maxlength
+    b.optional :pattern
+    b.optional :min_max
+    b.optional :readonly
+    b.use :label, class: 'col-sm-3 control-label'
+
+    b.wrapper tag: 'div', class: 'col-sm-9' do |ba|
+      ba.use :input, class: 'form-control'
+      ba.use :error, wrap_with: { tag: 'span', class: 'help-block' }
+      ba.use :hint,  wrap_with: { tag: 'p', class: 'help-block' }
+    end
+  end
+
+  config.wrappers :horizontal_file_input, tag: 'div', class: 'form-group', error_class: 'has-error' do |b|
+    b.use :html5
+    b.use :placeholder
+    b.optional :maxlength
+    b.optional :readonly
+    b.use :label, class: 'col-sm-3 control-label'
+
+    b.wrapper tag: 'div', class: 'col-sm-9' do |ba|
+      ba.use :input
+      ba.use :error, wrap_with: { tag: 'span', class: 'help-block' }
+      ba.use :hint,  wrap_with: { tag: 'p', class: 'help-block' }
+    end
+  end
+
+  config.wrappers :horizontal_boolean, tag: 'div', class: 'form-group', error_class: 'has-error' do |b|
+    b.use :html5
+    b.optional :readonly
+
+    b.wrapper tag: 'div', class: 'col-sm-offset-3 col-sm-9' do |wr|
+      wr.wrapper tag: 'div', class: 'checkbox' do |ba|
+        ba.use :label_input, class: 'col-sm-9'
+      end
+
+      wr.use :error, wrap_with: { tag: 'span', class: 'help-block' }
+      wr.use :hint,  wrap_with: { tag: 'p', class: 'help-block' }
+    end
+  end
+
+  config.wrappers :horizontal_radio_and_checkboxes, tag: 'div', class: 'form-group', error_class: 'has-error' do |b|
+    b.use :html5
+    b.optional :readonly
+
+    b.use :label, class: 'col-sm-3 control-label'
+
+    b.wrapper tag: 'div', class: 'col-sm-9' do |ba|
+      ba.use :input
+      ba.use :error, wrap_with: { tag: 'span', class: 'help-block' }
+      ba.use :hint,  wrap_with: { tag: 'p', class: 'help-block' }
+    end
+  end
+
+  config.wrappers :inline_form, tag: 'div', class: 'form-group', error_class: 'has-error' do |b|
+    b.use :html5
+    b.use :placeholder
+    b.optional :maxlength
+    b.optional :pattern
+    b.optional :min_max
+    b.optional :readonly
+    b.use :label, class: 'sr-only'
+
+    b.use :input, class: 'form-control'
+    b.use :error, wrap_with: { tag: 'span', class: 'help-block' }
+    b.use :hint,  wrap_with: { tag: 'p', class: 'help-block' }
+  end
+
+  config.default_wrapper = :vertical_form
+  config.wrapper_mappings = {
+    check_boxes: :vertical_radio_and_checkboxes,
+    radio_buttons: :vertical_radio_and_checkboxes,
+    file: :vertical_file_input,
+    boolean: :vertical_boolean
+  }
+end

data/lib/tramway/generators.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+module Tramway::Generators
+end

data/lib/tramway/navbar.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Tramway::Navbar
+  def navbar_structure(*links, project:)
+    @navbar_structure ||= {}
+    @navbar_structure.merge! project => links
+  end
+
+  def navbar_items_for(project, role:)
+    project = project.underscore.to_sym unless project.is_a? Symbol
+
+    return [] unless @navbar_structure&.dig(project).present?
+
+    @navbar_structure[project].map { |item| add_to_navbar item, project, role }.compact || []
+  end
+
+  private
+
+  def should_be_in_navbar_as(item, project, role)
+    if singleton_models_for(project, role: role).map(&:to_s).include?(item.to_s)
+      { item.to_s => :singleton }
+    elsif available_models_for(project, role: role).map(&:to_s).include?(item.to_s)
+      { item.to_s => :record }
+    elsif item.is_a? Symbol
+      :divider
+    end
+  end
+
+  def parse_hash_options_to_navbar(item, project, role)
+    sub_items = item.values.first.map do |sub_item|
+      should_be_in_navbar_as sub_item, project, role
+    end.compact
+    { item.keys.first => sub_items } if sub_items.any?
+  end
+
+  def add_to_navbar(item, project, role)
+    case item
+    when Class, String
+      should_be_in_navbar_as item, project, role
+    when Hash
+      parse_hash_options_to_navbar item, project, role
+    end
+  end
+end

data/lib/tramway/notifications.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Tramway::Notifications
+  def set_notificable_queries(**queries)
+    @notificable_queries ||= {}
+    @notificable_queries.merge! queries
+  end
+
+  def notificable_queries
+    @notificable_queries
+  end
+end

data/lib/tramway/record_routes_helper.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Tramway::RecordRoutesHelper
+  def record_path(*args, **options)
+    options[:model] ||= params[:model]
+    super args, options
+  end
+
+  def edit_record_path(*args, **options)
+    options[:model] ||= params[:model]
+    super args, options
+  end
+
+  def new_record_path(*args, **options)
+    options[:model] ||= params[:model]
+    super args, options
+  end
+
+  def records_path(*args, **options)
+    options[:model] ||= params[:model]
+    super args, options
+  end
+end

data/lib/tramway/records_models.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Tramway::RecordsModels
+  def set_available_models(*models, project:, role: :admin)
+    initialize_available_models_for project, role
+
+    models.each do |model|
+      if model.instance_of?(Class) || model.instance_of?(String)
+        @available_models[project][role].merge! model.to_s => %i[index show update create destroy]
+      elsif model.instance_of?(Hash)
+        @available_models[project][role].merge! model
+      end
+    end
+    @available_models = @available_models.with_indifferent_access
+  end
+
+  def available_models_for(project, role: :admin)
+    project = project.underscore.to_sym unless project.is_a? Symbol
+    models = get_models_by_key(@available_models, project, role)
+    models = available_models_for_engine(project, role, models) if project_is_engine?(project)
+
+    models.map do |model|
+      model.instance_of?(String) ? model.constantize : model
+    end
+  end
+
+  def available_models(role:)
+    models_array models_type: :available, role: role
+  end
+
+  def clear_available_models!
+    @available_models = {}
+  end
+
+  private
+
+  def initialize_available_models_for(project, role)
+    @available_models ||= {}
+    @available_models[project] ||= {}
+    @available_models[project][role] ||= {}
+  end
+
+  def available_models_for_engine(project, role, models)
+    models + engine_class(project).dependencies.map do |dependency|
+      if @available_models&.dig(dependency, role).present?
+        @available_models&.dig(dependency, role)&.keys
+      else
+        Tramway::Error.raise_error :records, :there_is_no_dependency, dependency: dependency, project: project
+      end
+    end.flatten.compact
+  end
+end

data/lib/tramway/singleton_models.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Tramway::SingletonModels
+  def set_singleton_models(*models, project:, role: :admin)
+    @singleton_models ||= {}
+    @singleton_models[project] ||= {}
+    @singleton_models[project][role] ||= {}
+    models.each do |model|
+      if model.instance_of?(Class)
+        @singleton_models[project][role].merge! model.to_s => %i[index show update create destroy]
+      elsif model.instance_of?(Hash)
+        @singleton_models[project][role].merge! model.to_s
+      end
+    end
+    @singleton_models = @singleton_models.with_indifferent_access
+  end
+
+  def singleton_models_for(project, role: :admin)
+    project = project.underscore.to_sym unless project.is_a? Symbol
+    models = get_models_by_key(@singleton_models, project, role)
+    if project_is_engine?(project)
+      models += engine_class(project).dependencies.map do |dependency|
+        @singleton_models&.dig(dependency, role)&.keys
+      end.flatten.compact
+    end
+    models
+  end
+
+  def singleton_models(role:)
+    models_array models_type: :singleton, role: role
+  end
+end

data/lib/tramway/spec/helpers/navbar_helper.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module NavbarHelper
+  def click_on_dropdown(text)
+    first('ul.navbar-nav li.nav-item.dropdown a.nav-link.dropdown-toggle', text: text, visible: true).click
+  end
+end

data/lib/tramway/spec/helpers/tramway_helpers.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module TramwayHelpers
+  def click_on_association_delete_button(object)
+    delete_path = ::Tramway::Engine.routes.url_helpers.record_path(
+      object.id,
+      model: object.class
+    )
+    row = find("td[colspan='2'] td a[href='#{delete_path}']").parent_node(level: 2)
+    row.find('td button.delete[type="submit"]').click
+  end
+
+  def click_on_tab(text)
+    find('li.nav-item a.nav-link', text: text).click
+  end
+
+  def click_on_table_item(text)
+    find('table td a', text: text).click
+  end
+
+  def click_on_delete_button(object)
+    delete_path = ::Tramway::Engine.routes.url_helpers.record_path(
+      object.id,
+      model: object.class
+    )
+    form = find("form[action='#{delete_path}']")
+    form.find('button[type="submit"]').click
+  end
+
+  def fill_in_ckeditor(name, with:)
+    id = name.gsub(']', '').split('[').join('_')
+    content = with.to_json # convert to a safe javascript string
+    page.execute_script <<-SCRIPT
+      CKEDITOR.instances['#{id}'].setData(#{content});
+      $('textarea##{id}').text(#{content});
+    SCRIPT
+  end
+
+  def fill_in_datepicker(name, with:)
+    return unless with.present?
+
+    input = find("input[name=#{name.gsub('[', '\[').gsub(']', '\]')}]")
+    input.click
+
+    find('td.day', text: /^#{with.day}$/, match: :first).click
+  end
+end

data/lib/tramway/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Tramway
-  VERSION = "0.1.0"
+  VERSION = '0.1.1'
 end

data/lib/tramway/welcome_page_actions.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Tramway::WelcomePageActions
+  attr_accessor :welcome_page_actions
+end

data/lib/tramway/yaml/errors.yml

@@ -0,0 +1,49 @@
+tramway:
+  project:
+    no_instance_of_application_class: "Looks like you have not create at least one instance of %{application_class} model OR Tramway Application Model is nil"
+  collections:
+    helper:
+      collection_list_by:
+        there_no_such_collection: "There no such collection named %{name_camelize}. Please create class with self method `list` and extended of `Tramway::Collection`. You should reload your server after creating this collection."
+  input_helper:
+    association_params:
+      defined_with_property_method: "It seems you've defined association attributes with `property` method. Please, use `association` method. `association :%{property}`"
+      use_polymorphic_association: "It seems you've used `association` input type in the Form. Please, use `polymorphic_association` type. `%{property}: :polymorphic_association`"
+  title_helper:
+    title:
+      you_should_set_tramway_application: "You should set Tramway::Core::Application class using `::Tramway::Core.initialize_application model_class: #{model_class_name}` in config/initializers/tramway.rb OR maybe you don't have any records of application model"
+  application_form:
+    initialize:
+      polymorphic_class_is_nil: "Polymorphic association class is nil. Maybe, you should write `assocation #{association_name}` after `properties #{association_name}_id, #{association_name}_type`"
+    validates:
+      you_need_to_set_model_class: 'You need to set `model_class` name while using validations. Just write `self.model_class = YOUR_MODEL_NAME` in the class area.'
+    submit:
+      params_should_not_be_nil: "ApplicationForm::Params should not be nil"
+    save:
+      looks_like_you_have_method: "Looks like you have method `%{method_name}` in %{model_class}. You should rename it or rename property in %{class_name}"
+      argument_error: "We have ArgumentError with message: %{message}"
+    model_class: 
+      there_is_not_model_class: "There is not model class name for %{name}. Should be %{model_class_name} or you can use another class to initialize form object or just initialize form with object."
+  concerns:
+    attribute_decorator_helper:
+      you_should_mount_photo_uploader: "You should mount PhotoUploader to your model. Just add `mount_uploader %{attribute_name}, PhotoUploader` to your model. %{message}"
+  associations:
+    object_helper:
+      please_specify_association_name: "Please, specify `%{association_name}` association class_name in %{object_class} model. For example: `has_many :%{association_name}, class_name: '%{association_class_name}'`"
+      habtm_add_class_not_defined: "You should define class `%{class}` to be able add and remove `%{association_name}`"
+    class_helper:
+      model_does_not_have_association: "Model %{object_class} does not have association named `%{association_name}`"
+  application_decorator:
+    attributes:
+      method_is_reserved_word: "Method `%{attribute_name}` is reserved word. Please, create or delegate method in %{class_name} with another name."
+    title:
+      please_implement_title: "Please, implement `title` method in a %{class_name} or delegate it to %{object_class}"
+    link:
+      method_link_uses_file_attribute: "Method `link` uses `file` attribute of the decorated object. If decorated object doesn't contain `file`, you shouldn't use `link` method."
+  generators:
+    install: 'Initialize Tramway application before running generators. Add `Tramway.initialize_application name: :your_application_name` to `config/initializers/tramway.rb`'
+  records:
+    there_is_no_dependency: "There is no dependency `%{dependency}` for plugin: %{project}. Please, check file `tramway-%{project}/lib/tramway/%{project}/%{project}.rb`"
+  application_controller:
+    create_form_for_role: "Tramway - you should create form for role `%{role}` to edit %{model_class} model. It should be named %{class_name}"
+    model_or_form_not_available: 'Tramway - Model or Form is not available. Looks like current user does not have access to change this model. Update your tramway initializer file'

data/lib/tramway.rb

@@ -1,5 +1,146 @@
-require "tramway/version"
+# frozen_string_literal: true
+
+require 'tramway/engine'
+require 'tramway/collection'
+require 'tramway/collections/helper'
+require 'font_awesome5_rails'
+require 'pg_search'
+require 'validators/presence_validator'
+require 'tramway/singleton_models'
+require 'tramway/records_models'
+require 'tramway/forms'
+require 'tramway/notifications'
+require 'tramway/welcome_page_actions'
+require 'tramway/navbar'
+require 'tramway/error'
+require 'tramway/generators/install_generator'
+require 'tramway/class_name_helpers'
 
 module Tramway
-  # Your code goes here...
+  class << self
+    def initialize_application(**options)
+      @application ||= Tramway::Application.new
+
+      options.each { |attr, value| @application.send "#{attr}=", value }
+    end
+
+    def application_object
+      @application&.model_class.present? ? @application.model_class.first : @application
+    end
+
+    def root
+      File.dirname __dir__
+    end
+
+    attr_reader :application, :customized_admin_navbar
+
+    include Tramway::RecordsModels
+    include Tramway::SingletonModels
+    include Tramway::Forms
+    include Tramway::Notifications
+    include Tramway::WelcomePageActions
+    include Tramway::Navbar
+
+    def engine_class(project)
+      class_name = "Tramway::#{project.to_s.camelize}"
+      class_name.classify.safe_constantize
+    end
+
+    def project_is_engine?(project)
+      engine_class(project)
+    end
+
+    def get_models_by_key(checked_models, project, role)
+      unless project.present?
+        Tramway::Error.raise_error(
+          :tramway,
+          :project,
+          :no_instance_of_application_class,
+          application_class: Tramway.application.model_class
+        )
+      end
+
+      checked_models && checked_models[project]&.dig(role)&.keys || []
+    end
+
+    def models_array(models_type:, role:)
+      instance_variable_get("@#{models_type}_models")&.map { |projects| projects.last[role]&.keys }&.flatten || []
+    end
+
+    def action_is_available?(record, project:, role:, model_name:, action:)
+      project = project.underscore.to_sym unless project.is_a? Symbol
+      actions = select_actions(project: project, role: role.to_sym, model_name: model_name)
+      availability = compute_availability actions, action
+
+      return false unless availability.present?
+      return true if availability.is_a? Symbol
+
+      availability.call record
+    end
+
+    def compute_availability(actions, action)
+      case actions
+      when Array
+        actions.select { |a| a.to_sym == action.to_sym }.first
+      when Hash
+        actions[action.to_sym]
+      end
+    end
+
+    def select_actions(project:, role:, model_name:)
+      stringify = ->(models) { stringify_keys(models&.dig(project, role))&.dig(model_name) }
+      stringify.call(@singleton_models) || stringify.call(@available_models)
+    end
+
+    def stringify_keys(hash)
+      hash&.reduce({}) { |new_hash, pair| new_hash.merge! pair[0].to_s => pair[1] }
+    end
+
+    def admin_model
+      auth_config.first[:user_model]
+    end
+
+    def auth_config
+      @@auth_config ||= [{ user_model: Tramway::User, auth_attributes: :email }]
+      @@auth_config
+    end
+
+    def auth_config=(params)
+      case params
+      when Hash
+        @@auth_config = [params]
+      when Array
+        @@auth_config = params
+      end
+    end
+
+    def user_based_models
+      @@auth_config ||= []
+      @@auth_config.map do |conf|
+        conf[:user_model]
+      end
+    end
+
+    def auth_attributes
+      @@auth_config ||= []
+      @@auth_config.reduce({}) do |hash, conf|
+        hash.merge! conf[:user_model] => conf[:auth_attributes]
+      end
+    end
+
+    def root_path_for=(**options)
+      @root_path ||= {}
+      @root_path.merge! options
+    end
+
+    def root_path_for(user_class)
+      @root_path&.dig(user_class) || '/'
+    end
+  end
+end
+
+# HACK: FIXME
+
+class ActiveModel::Errors
+  def merge!(*args); end
 end

data/lib/validators/presence_validator.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class PresenceValidator
+  def initialize(attributes); end
+
+  def valid?(value)
+    value.present?
+  end
+end