tramway 0.1.0 → 0.1.1

data/config/locales/en/date.yml

@@ -0,0 +1,16 @@
+en:
+  defaults: &defaults
+    month_names:
+      [~, January, February, March, April, May, June, July, August, September, October, November, December]
+    formats:
+       default: "%B %d %Y"
+       short: "%m/%d/%Y"
+  date:
+    <<: *defaults
+    order:
+      - :day
+      - :month
+      - :year
+  time:
+    <<: *defaults
+

data/config/locales/en/dates.yml

@@ -0,0 +1,10 @@
+en:
+  date:
+    from: from
+    to: to
+    formats:
+      default: "%m/%d/%Y"
+    month_names: [~, January, February, March, April, May, June, July, August, September, October, November, December]
+  time:
+    formats:
+      default: "%m/%d/%Y %H:%M"

data/config/locales/en/helpers.yml

@@ -0,0 +1,26 @@
+en:
+  helpers:
+    links:
+      enter: Sign In
+      save: Save
+      back: Back
+      sign_out: Sign Out
+      actions: Actions
+      open: Open
+    actions:
+      create: Create
+      update: Update
+      search: Search
+      reset: Reset
+      download: Download
+      add: Add
+    scope:
+      found: Found
+    "yes": yes
+    "no": no
+  tramway:
+    auth:
+      web:
+        sessions:
+          new:
+            title: Sign In

data/config/locales/en/locale.yml

@@ -0,0 +1,11 @@
+en:
+  tramway:
+    admin:
+      welcome:
+        index:
+          title: Admin panel
+    auth:
+      web:
+        sessions:
+          new:
+            title: Sign In

data/config/locales/en/messages.yml

@@ -0,0 +1,7 @@
+en:
+  tramway:
+    shared:
+      messages:
+        some_errors_was_found: There are errors
+  errors:
+    wrong_email_or_password: Wrong email or password

data/config/locales/en/models.yml

@@ -0,0 +1,9 @@
+en:
+  activerecord:
+    attributes:
+      tramway/application_record:
+        created_at: Created at
+        updated_at: Updated at
+        state: State
+  errors:
+    wrong_email_or_password: Wrong email or password

data/config/locales/en/simple_form_extension.yml

@@ -0,0 +1,8 @@
+en:
+  simple_form:
+    extension:
+      selectize:
+        add: Add
+      file:
+        select: Select file
+        change: Change file

data/config/locales/en/state_machines.yml

@@ -0,0 +1,8 @@
+en:
+  activerecord:
+    state_machines:
+      tramway/application_record:
+        state:
+          states:
+            active: Active
+            removed: Removed

data/config/locales/ru/collections.yml

@@ -0,0 +1,4 @@
+ru:
+  default:
+    collections:
+      all: Все

data/config/locales/ru/date.yml

@@ -0,0 +1,16 @@
+ru:
+  defaults: &defaults
+    month_names:
+      [~, Январь, Февраль, Март, Апрель, Май, Июнь, Июль, Август, Сентябрь, Октябрь, Ноябрь, Декабрь]
+    formats:
+       default: "%d. %B %Y"
+       short: "%d.%m.%Y"
+  date:
+    <<: *defaults
+    order:
+      - :day
+      - :month
+      - :year
+  time:
+    <<: *defaults
+

data/config/locales/ru/dates.yml

@@ -0,0 +1,10 @@
+ru:
+  date:
+    from: с
+    to: по
+    formats:
+      default: "%d.%m.%Y"
+    month_names: [~, января, февраля, марта, апреля, мая, июня, июля, августа, сентября, октября, ноября, декабря]
+  time:
+    formats:
+      default: "%d.%m.%Y %H:%M"

data/config/locales/ru/helpers.yml

@@ -0,0 +1,30 @@
+ru:
+  helpers:
+    links:
+      enter: Войти
+      save: Сохранить
+      back: Назад
+      sign_out: Выйти
+      actions: Действия
+      open: Открыть
+    actions:
+      create: Создать
+      update: Редактировать
+      search: Искать
+      reset: Сбросить
+      download: Скачать
+      add: Добавить
+    scope:
+      found: Найденные
+    "yes": Да
+    "no": Нет
+  tramway:
+    admin:
+      welcome:
+        index:
+          title: Админка
+    auth:
+      web:
+        sessions:
+          new:
+            title: Авторизация

data/config/locales/ru/locale.yml

@@ -0,0 +1,6 @@
+ru:
+  tramway:
+    admin:
+      welcome:
+        index:
+          title: Админка

data/config/locales/ru/messages.yml

@@ -0,0 +1,7 @@
+ru:
+  tramway:
+    shared:
+      messages:
+        some_errors_was_found: Найдены ошибки
+  errors:
+    wrong_email_or_password: Неверный логин или пароль

data/config/locales/ru/models.yml

@@ -0,0 +1,21 @@
+ru:
+  activerecord:
+    models:
+      tramway/user/user: Пользователь
+    attributes:
+      tramway/application_record:
+        created_at: Создан
+        updated_at: Обновлён
+        state: Статус
+      tramway/user:
+        password: Пароль
+    errors:
+      models:
+        tramway/user/user:
+          attributes:
+            email:
+              email: имеет неверный формат
+  cases:
+    tramway/user:
+      plural: пользователи
+      genitive: пользователя

data/config/locales/ru/simple_form_extension.yml

@@ -0,0 +1,8 @@
+ru:
+  simple_form:
+    extension:
+      selectize:
+        add: Добавить
+      file:
+        select: Выбрать файл
+        change: Изменить файл

data/config/locales/ru/state_machines.yml

@@ -0,0 +1,8 @@
+ru:
+  activerecord:
+    state_machines:
+      tramway/application_record:
+        state:
+          states:
+            active: Активный
+            removed: Удалённый

data/config/routes.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+Tramway::Engine.routes.draw do
+  mount Tramway::Export::Engine, at: '/' if defined? Tramway::Export::Engine
+
+  root to: 'welcome#index'
+
+  resources :records
+  resource :singleton, only: %i[new create show edit update]
+  resources :has_and_belongs_to_many_records, only: %i[create destroy]
+  resource :session, only: %i[new create]
+  get 'sign_out', to: 'sessions#destroy'
+end

data/lib/string.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'active_support/inflector/methods'
+
+class String
+  def pluralize(count = nil, locale = :en)
+    case locale
+    when :ru
+      case count
+      when :many
+        I18n.t('cases.')
+      end
+    else
+      locale = count if count.is_a? Symbol
+      count == 1 ? dup : ActiveSupport::Inflector.pluralize(self, locale)
+    end
+  end
+end

data/lib/tramway/application.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+class Tramway::Application
+  attr_accessor :name, :url, :model_class, :title, :tagline, :found_date, :phone, :email, :main_image, :favicon,
+    :short_description
+
+  def public_name
+    name.to_s.gsub('_', ' ').camelize
+  end
+end

data/lib/tramway/class_name_helpers.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Tramway::ClassNameHelpers
+  def model_class_name(class_name)
+    class_name.constantize
+  end
+
+  def decorator_class_name(class_name = -> { model_class }.call)
+    "#{class_name}Decorator".constantize
+  end
+
+  def form_class_name(class_name = -> { model_class }.call)
+    "#{class_name}Form".constantize
+  end
+end

data/lib/tramway/collection.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class Tramway::Collection
+  class << self
+    def list
+      raise 'Please add collection to list method'
+    end
+  end
+end

data/lib/tramway/collections/helper.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'tramway/collections'
+
+module Tramway::Collections::Helper
+  def collection_list_by(name:)
+    begin
+      require name # needed to load class name with collection
+    rescue LoadError
+      raise "No such file #{name}. You should create file in the `lib/#{name}.rb` or elsewhere you want"
+    end
+    unless ::Tramway::Collection.descendants.map(&:to_s).include?(name.camelize)
+      ::Tramway::Error.raise_error(
+        :tramway, :collections, :helper, :collection_list_by, :there_no_such_collection,
+        name_camelize: name.camelize
+      )
+    end
+
+    name.camelize.constantize.list
+  end
+end

data/lib/tramway/collections.rb

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

data/lib/tramway/engine.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'tramway/generators/install_generator'
+require 'tramway/application'
+require 'simple_form'
+require 'enumerize'
+
+class Tramway::Engine < ::Rails::Engine
+  isolate_namespace Tramway
+
+  config.before_initialize do
+    config.i18n.load_path += Dir["#{config.root}/config/locales/**/*.yml"]
+  end
+end

data/lib/tramway/error.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+class Tramway::Error < RuntimeError
+  def initialize(*args, plugin: nil, method: nil, message: nil)
+    @properties = {}
+    @properties[:plugin] = plugin
+    @properties[:method] = method
+    @properties[:message] = message
+    super(*args)
+  end
+
+  def message
+    "Plugin: #{@properties[:plugin]}; Method: #{@properties[:method]}; Message: #{@properties[:message]}"
+  end
+
+  def properties
+    @properties ||= {}
+  end
+
+  class << self
+    def raise_error(*coordinates, **options)
+      @errors ||= YAML.load_file("#{Tramway.root}/lib/tramway/yaml/errors.yml").with_indifferent_access
+      error = @errors.dig(*coordinates)
+      raise 'Error is not defined in YAML' unless error
+
+      options.each do |pair|
+        error.gsub!("%{#{pair[0]}}", pair[1].to_s)
+      end
+      raise error
+    end
+  end
+end

data/lib/tramway/forms.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Tramway::Forms
+  attr_accessor :forms
+end

data/lib/tramway/generators/install_generator.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+require 'tramway/generators'
+require 'tramway/generators/model_generator'
+
+class Tramway::Generators::InstallGenerator < ::Rails::Generators::Base
+  source_root File.expand_path('templates', __dir__)
+  class_option :user_role, type: :string, default: 'admin'
+  include Rails::Generators::Migration
+
+  def run_other_generators
+    generate 'audited:install'
+  end
+
+  def self.next_migration_number(path)
+    next_migration_number = current_migration_number(path) + 1
+    ActiveRecord::Migration.next_migration_number next_migration_number
+  end
+
+  def copy_initializer
+    simple_form_files = %w[simple_form simple_form_bootstrap]
+    simple_form_files.each do |file|
+      copy_file(
+        "/#{File.dirname __dir__}/generators/templates/initializers/#{file}.rb",
+        "config/initializers/#{file}.rb"
+      )
+    end
+  end
+
+  def copy_migrations
+    migrations = %i[
+      create_tramway_users
+    ]
+
+    migrations.each do |migration|
+      migration_template "#{migration}.rb", "db/migrate/#{migration}.rb"
+    end
+  end
+
+  def run_decorator_generators
+    Tramway::Error.raise_error(:tramway, :generators, :install) unless Tramway.application.present?
+
+    project = Tramway.application.name
+    Tramway.available_models_for(project).map do |model|
+      generate 'tramway:model', model.to_s, "--user-role=#{options[:user_role]}"
+    end
+  end
+end

data/lib/tramway/generators/model_generator.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+require 'rails/generators/named_base'
+
+class Tramway::Generators::ModelGenerator < ::Rails::Generators::NamedBase
+  source_root File.expand_path('templates', __dir__)
+  class_option :user_role, type: :string, default: 'admin'
+
+  COLLECTION_ATTRIBUTE_LIMIT = 4 # limiting columns in #index table
+  ATTRIBUTE_TYPE_MAPPING = {
+    date: :date_picker,
+    datetime: :date_picker,
+    time: :date_picker,
+    text: :text,
+    string: :string,
+    uuid: :string,
+    float: :float,
+    integer: :integer,
+    boolean: :boolean
+  }.freeze
+  DEFAULT_FIELD_TYPE = :string
+  READ_ONLY_ATTRIBUTES = %w[id uuid created_at updated_at].freeze
+
+  def run_decorator_generator
+    template(
+      'decorator.rb.erb',
+      Rails.root.join("app/decorators/#{file_path}_decorator.rb")
+    )
+  end
+
+  def run_forms_generator
+    template(
+      'form.rb.erb',
+      Rails.root.join("app/forms/#{user_role}/#{file_path}_form.rb")
+    )
+  end
+
+  private
+
+  def user_role
+    options[:user_role]
+  end
+
+  def attributes
+    # TODO: this for model associations, but they probably should be handled differently
+    # klass.reflections.keys +
+
+    klass.columns.map(&:name) -
+      redundant_attributes
+  end
+
+  def form_attributes
+    attributes - READ_ONLY_ATTRIBUTES
+  end
+
+  def form_type(attribute)
+    type = column_type_for_attribute(attribute.to_s)
+
+    if type
+      ATTRIBUTE_TYPE_MAPPING.fetch(type, DEFAULT_FIELD_TYPE)
+      # else
+      #   association_type(attribute)
+    end
+  end
+
+  def redundant_attributes
+    klass.reflections.keys.flat_map do |relationship|
+      redundant_attributes_for(relationship)
+    end.compact
+  end
+
+  def redundant_attributes_for(relationship)
+    case association_type(relationship)
+    when :polymorphic
+      ["#{relationship}_id", "#{relationship}_type"]
+    when :belongs_to
+      "#{relationship}_id"
+    end
+  end
+
+  def association_type(attribute)
+    relationship = klass.reflections[attribute.to_s]
+    if relationship.has_one?
+      :has_one
+    elsif relationship.collection?
+      :has_many
+    elsif relationship.polymorphic?
+      :polymorphic
+    else
+      :belongs_to
+    end
+  end
+
+  def column_type_for_attribute(attr)
+    column_types(attr)
+  end
+
+  def column_types(attr)
+    klass.columns.find { |column| column.name == attr }.try(:type)
+  end
+
+  def klass
+    @klass ||= Object.const_get(class_name)
+  end
+end

data/lib/tramway/generators/templates/create_tramway_users.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+class CreateTramwayUsers < ActiveRecord::Migration[5.1]
+  def change
+    create_table :tramway_users do |t|
+      t.text :email
+      t.text :password_digest
+      t.text :first_name
+      t.text :last_name
+      t.text :avatar
+      t.text :role
+      t.text :phone
+      t.datetime :deleted_at
+
+      t.timestamps null: false
+    end
+  end
+end

data/lib/tramway/generators/templates/decorator.rb.erb

@@ -0,0 +1,56 @@
+class <%= class_name %>Decorator < Tramway::ApplicationDecorator
+  # Associations you want to show in admin dashboard
+  # decorate_associations :messages, :posts
+
+  delegate_attributes(
+<% attributes.each do |attr| -%>
+        :<%= attr %>,
+<% end -%>
+  )
+
+  class << self
+    def collections
+      # [ :all, :scope1, :scope2 ]
+      [ :all ]
+    end
+
+    def list_attributes
+      [
+<% attributes.first(COLLECTION_ATTRIBUTE_LIMIT).each do |attr| -%>
+        :<%= attr %>,
+<% end -%>
+      ]
+    end
+
+    def show_attributes
+      [
+<% attributes.each do |attr| -%>
+        :<%= attr %>,
+<% end -%>
+      ]
+    end
+
+    def show_associations
+      # Associations you want to show in admin dashboard
+      # [ :messages ]
+    end
+
+    def list_filters
+      # {
+      #   filter_name: {
+      #     type: :select,
+      #     select_collection: filter_collection,
+      #     query: lambda do |list, value|
+      #       list.where some_attribute: value
+      #     end
+      #   },
+      #   date_filter_name: {
+      #     type: :dates,
+      #     query: lambda do |list, begin_date, end_date|
+      #       list.where 'created_at > ? AND created_at < ?', begin_date, end_date
+      #     end
+      #   }
+      # }
+    end
+  end
+end

data/lib/tramway/generators/templates/form.rb.erb

@@ -0,0 +1,22 @@
+class <%= user_role.capitalize %>::<%= class_name %>Form < Tramway::ApplicationForm
+  properties <%= form_attributes.map{ |a| ":#{a}" }.join(', ') %>
+
+  def initialize(object)
+    super(object).tap do
+      # Here is the mapping from model attributes to simple_form inputs.
+      # form_properties title: :string,
+      #   logo: :file,
+      #   description: :ckeditor,
+      #   games: :association,
+      #   date: :date_picker,
+      #   text: :text,
+      #   birth_date: {
+      #     type: :default,
+      #     input_options: {
+      #       hint: 'It should be more than 18'
+      #     }
+      #   }
+      form_properties <%= form_attributes.map{ |attr| "#{attr}: :#{form_type(attr)}"}.join(",\n        ") %>
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+SimpleForm.setup do |config|
+  config.wrappers :default, class: :input,
+    hint_class: :field_with_hint, error_class: :field_with_errors do |b|
+    b.use :html5
+    b.use :placeholder
+    b.optional :maxlength
+    b.optional :pattern
+    b.optional :min_max
+    b.optional :readonly
+    b.use :label_input
+    b.use :hint,  wrap_with: { tag: :span, class: :hint }
+    b.use :error, wrap_with: { tag: :span, class: :error }
+  end
+  config.default_wrapper = :default
+  config.boolean_style = :nested
+  config.button_class = 'btn'
+  config.error_notification_tag = :div
+  config.error_notification_class = 'error_notification'
+  config.browser_validations = false
+  config.boolean_label_class = 'checkbox'
+end