biovision-regions 0.1.180120

data/app/views/admin/admin/privileges/regions.jbuilder

@@ -0,0 +1,10 @@
+json.data @collection do |entity|
+  json.id entity.id
+  json.type entity.class.table_name
+  json.attributes do
+    json.(entity, :name, :long_slug, :children_cache)
+  end
+  json.meta do
+    json.html_chunk render(partial: 'admin/privileges/entity/region', formats: [:html], locals: { privilege: @entity, region: entity, user: @user })
+  end
+end

data/app/views/admin/index/dashboard/_biovision_regions.html.erb

@@ -0,0 +1,8 @@
+<% if current_user_in_group?(:region_managers) %>
+  <nav>
+    <div class="heading"><%= t('.heading') %></div>
+    <ul>
+      <li><%= render 'admin/regions/nav_item' %></li>
+    </ul>
+  </nav>
+<% end %>

data/app/views/admin/regions/_nav_item.html.erb

@@ -0,0 +1,2 @@
+<div><%= link_to t('.text'), admin_regions_path %></div>
+<div class="description"><%= t('.description') %></div>

data/app/views/admin/regions/entity/_in_list.html.erb

@@ -0,0 +1,20 @@
+<div class="image">
+  <%= region_image_preview(entity) %>
+</div>
+<div class="data">
+  <div><%= admin_region_link(entity) %></div>
+  <div class="info">
+    <div><%= entity.long_slug %></div>
+  </div>
+  <div class="secondary info">
+    <%= t(:user_count, count: entity.users_count) %>
+  </div>
+  <%= render partial: 'shared/admin/toggleable', locals: { entity: entity, url: toggle_admin_region_path(entity.id) } %>
+
+  <ul class="actions">
+    <li class="lockable <%= (entity.editable_by?(current_user) && !entity.locked?) ? '' : 'hidden' %>">
+      <%= edit_icon edit_region_path(entity) %>
+    </li>
+    <%= render partial: 'shared/actions/locks', locals: { entity: entity, path: lock_admin_region_path(entity) } %>
+  </ul>
+</div>

data/app/views/admin/regions/index.html.erb

@@ -0,0 +1,22 @@
+<% content_for :meta_title, t('.title') %>
+<% content_for :breadcrumbs do %>
+    <span><%= t('admin.regions.nav_item.text') %></span>
+<% end %>
+
+<article>
+  <h1><%= t('.heading') %></h1>
+
+  <ul class="actions">
+    <li><%= back_icon(admin_path) %></li>
+  </ul>
+
+  <%= render partial: 'shared/admin/list', locals: { collection: @collection } %>
+
+  <% if current_user_has_privilege?(:administrator) %>
+      <section>
+        <h2><%= t('regions.new.heading') %></h2>
+
+        <%= render partial: 'regions/form', locals: { entity: Region.new } %>
+      </section>
+  <% end %>
+</article>

data/app/views/admin/regions/show.html.erb

@@ -0,0 +1,95 @@
+<% content_for :meta_title, t('.title', name: @entity.name) %>
+<% content_for :breadcrumbs do %>
+    <%= link_to(t('admin.regions.nav_item.text'), admin_regions_path) %>
+    <% @entity.parents.each do |parent| %>
+        <%= admin_region_link(parent) %>
+    <% end %>
+    <span><%= @entity.name %></span>
+<% end %>
+
+<article>
+  <h1><%= @entity.name %></h1>
+
+  <ul class="actions">
+    <li><%= back_icon(admin_regions_path) %></li>
+    <% if @entity.editable_by?(current_user) && !@entity.locked? %>
+        <li><%= edit_icon edit_region_path(@entity.id) %></li>
+    <% end %>
+  </ul>
+
+  <% unless @entity.header_image.blank? %>
+      <figure>
+        <%= image_tag(@entity.header_image.medium.url) %>
+        <figcaption>
+          <%= t('activerecord.attributes.region.header_image') %>
+        </figcaption>
+      </figure>
+  <% end %>
+
+  <% unless @entity.image.blank? %>
+      <figure>
+        <%= image_tag(@entity.image.header.url) %>
+        <figcaption>
+          <%= t('activerecord.attributes.region.image') %>
+        </figcaption>
+      </figure>
+  <% end %>
+
+  <dl>
+    <dt><%= t('activerecord.attributes.region.long_slug') %></dt>
+    <dd>
+      <%= @entity.long_slug %>
+    </dd>
+
+    <% unless @entity.short_name.blank? %>
+        <dt><%= t('activerecord.attributes.region.short_name') %></dt>
+        <dd>
+          <%= @entity.short_name %>
+        </dd>
+    <% end %>
+
+    <% unless @entity.locative.blank? %>
+        <dt><%= t('activerecord.attributes.region.locative') %></dt>
+        <dd>
+          <%= @entity.locative %>
+        </dd>
+    <% end %>
+
+    <% unless @entity.parent.nil? %>
+        <dt><%= t('activerecord.attributes.region.parent_id') %></dt>
+        <dd>
+          <%= admin_region_link(@entity.parent) %>
+        </dd>
+    <% end %>
+
+    <% unless @entity.parents_cache.blank? %>
+        <dt><%= t('activerecord.attributes.region.parents_cache') %></dt>
+        <dd>
+          <%= @entity.parents_cache %>
+        </dd>
+    <% end %>
+
+    <% unless @entity.children_cache.blank? %>
+        <dt><%= t('activerecord.attributes.region.children_cache') %></dt>
+        <dd>
+          <%= @entity.children_cache.join(', ') %>
+        </dd>
+    <% end %>
+  </dl>
+
+  <% if @entity.child_regions.any? %>
+      <section>
+        <h2><%= t('.children') %></h2>
+
+        <%= render partial: 'shared/admin/list', locals: { collection: Region.for_tree(nil, @entity.id) } %>
+      </section>
+  <% end %>
+
+  <% if @entity.editable_by?(current_user) %>
+      <section>
+        <h2><%= t('regions.new.heading') %></h2>
+
+        <%= render partial: 'regions/form', locals: { entity: Region.new(parent: @entity) } %>
+      </section>
+  <% end %>
+</article>

data/app/views/layouts/biovision/regions/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Biovision regions</title>
+  <%= stylesheet_link_tag    "biovision/regions/application", media: "all" %>
+  <%= javascript_include_tag "biovision/regions/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/app/views/regions/_form.html.erb

@@ -0,0 +1,73 @@
+<%= render partial: 'shared/list_of_errors', locals: { entity: entity } %>
+
+<%= form_for entity do |f| %>
+    <dl>
+      <dt><%= f.label :image %></dt>
+      <dd>
+        <figure class="preview" id="region-image">
+          <% if entity.image.blank? %>
+              <% image = image_tag('region_image.svg') %>
+          <% else %>
+              <% image = image_tag(entity.image.url) %>
+          <% end %>
+          <%= label_tag('region_image', image) %>
+          <figcaption>
+            <%= f.file_field :image, accept: 'image/jpeg,image/png', data: { image: 'region-image' } %>
+          </figcaption>
+        </figure>
+      </dd>
+      <dt><%= f.label :header_image %></dt>
+      <dd>
+        <figure class="preview" id="region-header-image">
+          <% if entity.header_image.blank? %>
+              <% header_image = image_tag('biovision/base/placeholders/image.svg') %>
+          <% else %>
+              <% header_image = image_tag(entity.header_image.medium.url) %>
+          <% end %>
+          <%= label_tag('region_header_image', header_image) %>
+          <figcaption>
+            <%= f.file_field :header_image, accept: 'image/jpeg,image/png', data: { image: 'region-header-image' } %>
+            <div class="guideline"><%= t('.guidelines.header_image') %></div>
+          </figcaption>
+        </figure>
+      </dd>
+
+      <dt><%= f.label :name %></dt>
+      <dd>
+        <%= f.text_field :name, required: true, size: nil, maxlength: Region::NAME_LIMIT %>
+      </dd>
+
+      <dt><%= f.label :short_name %></dt>
+      <dd>
+        <%= f.text_field :short_name, required: true, size: nil, maxlength: Region::NAME_LIMIT %>
+        <div class="guideline">
+          <%= t('.guidelines.short_name') %>
+        </div>
+      </dd>
+
+      <dt><%= f.label :locative %></dt>
+      <dd>
+        <%= f.text_field :locative, required: true, size: nil, maxlength: Region::NAME_LIMIT, placeholder: t('.placeholders.locative') %>
+        <div class="guideline">
+          <%= t('.guidelines.locative') %>
+        </div>
+      </dd>
+
+      <dt><%= f.label :slug %></dt>
+      <dd>
+        <%= f.text_field :slug, required: true, size: nil, maxlength: Region::SLUG_LIMIT %>
+        <div class="guideline">
+          <%= t('.guidelines.slug') %>
+        </div>
+      </dd>
+    </dl>
+
+    <ul class="flags">
+      <li><%= f.check_box :visible %><%= f.label :visible %></li>
+    </ul>
+
+    <div class="buttons">
+      <%= f.hidden_field :parent_id if entity.id.nil? %>
+      <%= f.button t(:save), type: :submit %>
+    </div>
+<% end %>

data/app/views/regions/edit.html.erb

@@ -0,0 +1,20 @@
+<% content_for :meta_title, t('.title') %>
+<% content_for :breadcrumbs do %>
+    <%= link_to(t('admin.regions.nav_item.text'), admin_regions_path) %>
+    <% @entity.parents.each do |parent| %>
+        <%= admin_region_link(parent) %>
+    <% end %>
+    <%= admin_region_link(@entity) %>
+    <span><%= t(:edit) %></span>
+<% end %>
+
+<article>
+  <h1><%= t('.title') %></h1>
+
+  <ul class="actions">
+    <li><%= return_icon(admin_region_path(@entity.id)) %></li>
+    <li class="danger"><%= destroy_icon(@entity) %></li>
+  </ul>
+
+  <%= render partial: 'form', locals: { entity: @entity } %>
+</article>

data/app/views/regions/new.html.erb

@@ -0,0 +1,17 @@
+<% content_for :meta_title, t('.title') %>
+<% content_for :breadcrumbs do %>
+    <%= link_to(t('admin.regions.nav_item.text'), admin_regions_path) %>
+    <span><%= t(:create) %></span>
+<% end %>
+
+<article>
+  <h1><%= t('.heading') %></h1>
+
+  <% unless @entity.parent.nil? %>
+      <ul class="actions">
+        <li><%= return_icon(admin_region_path(@entity.parent_id)) %></li>
+      </ul>
+  <% end %>
+
+  <%= render partial: 'form', locals: { entity: @entity } %>
+</article>

data/config/locales/regions-en.yml

@@ -0,0 +1,73 @@
+en:
+  child_region_count:
+    zero: "no child regions"
+    one: "%{count} child region"
+    few: "%{count} child regions"
+    many: "%{count} child regions"
+    other: "%{count} child regions"
+  activerecord:
+    models:
+      region: "Регион"
+    attributes:
+      region:
+        country_id: "Country"
+        parent_id: "Родительский регион"
+        visible: "Показывать"
+        name: "Название"
+        slug: "Код"
+        long_slug: "Код для пути в URL"
+        image: "Герб"
+        header_image: "Картинка для шапки"
+        parents_cache: "Кеш родителей"
+        children_cache: "Кеш дочек"
+        latitude: "Широта центральной точки"
+        longitude: "Долгота центральной точки"
+        short_name: "Короткое название"
+        locative: "Локатив"
+      central_region:
+        name: "Центр"
+        short_name: "Центр"
+        locative: "в центре"
+  admin:
+    index:
+      dashboard:
+        biovision_regions:
+          heading: "Regions"
+    regions:
+      nav_item:
+        text: "Регионы"
+        description: "Управление регионами"
+      index:
+        title: "Регионы"
+        heading: "Регионы"
+      show:
+        title: "Регион «%{name}»"
+        children: "Дочерние регионы"
+    users:
+      entity:
+        privilege:
+          select_regions: "Выбрать регионы…"
+    privileges:
+      entity:
+        region:
+          deeper_level: "Уровни глубже…"
+  regions:
+    new:
+      title: "Новый регион"
+      heading: "Добавление региона"
+    edit:
+      title: "Редактирование региона"
+      heading: "Редактирование региона"
+      forbidden: "Редактирование этого региона запрещено"
+    update:
+      success: "Регион успешно изменён"
+    destroy:
+      success: "Регион успешно удалён"
+    form:
+      placeholders:
+        locative: "в Москве"
+      guidelines:
+        header_image: "Картинка в формате JPG или PNG размером 1000×220 (лишнее будет обрезано автоматически)"
+        slug: "Используется адресной строке. Только латинские буквы, дефис (кроме границ) и цифры, до 63 символов."
+        short_name: "Используется в списках"
+        locative: "Используется в предложениях вида «в таком-то регионе»"

data/config/locales/regions-ru.yml

@@ -0,0 +1,73 @@
+ru:
+  child_region_count:
+    zero: "дочерних регионов нет"
+    one: "%{count} дочерний регион"
+    few: "%{count} дочерних региона"
+    many: "%{count} дочерних регионов"
+    other: "%{count} дочерних регионов"
+  activerecord:
+    models:
+      region: "Регион"
+    attributes:
+      region:
+        country_id: "Страна"
+        parent_id: "Родительский регион"
+        visible: "Показывать"
+        name: "Название"
+        slug: "Код"
+        long_slug: "Код для пути в URL"
+        image: "Герб"
+        header_image: "Картинка для шапки"
+        parents_cache: "Кеш родителей"
+        children_cache: "Кеш дочек"
+        latitude: "Широта центральной точки"
+        longitude: "Долгота центральной точки"
+        short_name: "Короткое название"
+        locative: "Локатив"
+      central_region:
+        name: "Центр"
+        short_name: "Центр"
+        locative: "в центре"
+  admin:
+    index:
+      dashboard:
+        biovision_regions:
+          heading: "Региональность"
+    regions:
+      nav_item:
+        text: "Регионы"
+        description: "Управление регионами"
+      index:
+        title: "Регионы"
+        heading: "Регионы"
+      show:
+        title: "Регион «%{name}»"
+        children: "Дочерние регионы"
+    users:
+      entity:
+        privilege:
+          select_regions: "Выбрать регионы…"
+    privileges:
+      entity:
+        region:
+          deeper_level: "Уровни глубже…"
+  regions:
+    new:
+      title: "Новый регион"
+      heading: "Добавление региона"
+    edit:
+      title: "Редактирование региона"
+      heading: "Редактирование региона"
+      forbidden: "Редактирование этого региона запрещено"
+    update:
+      success: "Регион успешно изменён"
+    destroy:
+      success: "Регион успешно удалён"
+    form:
+      placeholders:
+        locative: "в Москве"
+      guidelines:
+        header_image: "Картинка в формате JPG или PNG размером 1000×220 (лишнее будет обрезано автоматически)"
+        slug: "Используется адресной строке. Только латинские буквы, дефис (кроме границ) и цифры, до 63 символов."
+        short_name: "Используется в списках"
+        locative: "Используется в предложениях вида «в таком-то регионе»"

data/config/routes.rb

@@ -0,0 +1,17 @@
+Biovision::Regions::Engine.routes.draw do
+
+  namespace :admin do
+    resources :regions, only: [:index, :show] do
+      member do
+        post 'priority', defaults: { format: :json }
+        post 'toggle', defaults: { format: :json }
+        put 'lock', defaults: { format: :json }
+        delete 'lock', action: :unlock, defaults: { format: :json }
+      end
+    end
+
+    # get 'privileges/:id/regions' => 'privileges#regions', as: :regions_admin_privilege, defaults: { format: :json }
+  end
+
+  resources :regions, except: [:index, :show]
+end

data/db/migrate/20180120000000_create_countries.rb

@@ -0,0 +1,41 @@
+class CreateCountries < ActiveRecord::Migration[5.1]
+  def up
+    unless Country.table_exists?
+      create_table :countries do |t|
+        t.timestamps
+        t.boolean :visible, default: true, null: false
+        t.integer :priority, limit: 2, default: 1, null: false
+        t.string :name, null: false
+        t.string :short_name
+        t.string :locative
+        t.string :slug
+      end
+
+      Country.create(name: 'Российская Федерация', short_name: 'Россия', locative: 'в России', slug: 'russia')
+
+      create_privileges
+    end
+  end
+
+  def down
+    if Country.table_exists?
+      drop_table :countries
+    end
+  end
+
+  def create_privileges
+    PrivilegeGroup.create(slug: 'region_managers', name: 'Управляющие регионами')
+
+    Privilege.create(slug: 'chief_region_manager', name: 'Главный управляющий регионамми')
+    Privilege.create(
+      parent: Privilege.find_by!(slug: 'chief_region_manager'),
+      slug: 'region_manager',
+      name: 'Управляющий регионом',
+      regional: true
+    )
+
+    group = PrivilegeGroup.find_by!(slug: 'region_managers')
+    group.add_privilege(Privilege.find_by(slug: 'chief_region_manager'))
+    group.add_privilege(Privilege.find_by(slug: 'region_manager'))
+  end
+end

data/db/migrate/20180120000005_create_regions.rb

@@ -0,0 +1,36 @@
+class CreateRegions < ActiveRecord::Migration[5.1]
+  def up
+    unless Region.table_exists?
+      create_table :regions do |t|
+        t.timestamps
+        t.references :country, foreign_key: { on_update: :cascade, on_delete: :cascade }
+        t.integer :parent_id
+        t.integer :users_count, default: 0, null: false
+        t.boolean :visible, default: true, null: false
+        t.boolean :locked, default: false, null: false
+        t.float :latitude
+        t.float :longitude
+        t.string :slug, null: false
+        t.string :long_slug, null: false, index: true
+        t.string :name, null: false
+        t.string :short_name
+        t.string :locative
+        t.string :image
+        t.string :header_image
+        t.string :image_url
+        t.text :map_geometry
+        t.text :svg_geometry
+        t.string :parents_cache, default: '', null: false
+        t.integer :children_cache, array: true, default: [], null: false
+      end
+
+      add_foreign_key :regions, :regions, column: :parent_id, on_update: :cascade, on_delete: :cascade
+    end
+  end
+
+  def down
+    if Region.table_exists?
+      drop_table :regions
+    end
+  end
+end

data/lib/biovision/regions/decorators/controllers/admin/privileges_controller_decorator.rb

@@ -0,0 +1,7 @@
+Admin::PrivilegesController.class_eval do
+  # get /admin/privileges/:id/regions
+  def regions
+    @user       = User.find_by(id: params[:user_id])
+    @collection = Region.visible.for_tree(params[:parent_id]).reject { |r| @entity.has_user?(@user, r.subbranch_ids) }
+  end
+end

data/lib/biovision/regions/decorators/models/user_decorator.rb

@@ -0,0 +1,3 @@
+User.class_eval do
+  belongs_to :region, optional: true, counter_cache: true
+end

data/lib/biovision/regions/decorators/models/user_privilege_decorator.rb

@@ -0,0 +1,3 @@
+UserPrivilege.class_eval do
+  belongs_to :region, optional: true
+end

data/lib/biovision/regions/engine.rb

@@ -0,0 +1,24 @@
+module Biovision
+  module Regions
+    require 'biovision/base'
+    require 'carrierwave'
+    require 'carrierwave-bombshelter'
+    require 'mini_magick'
+
+    class Engine < ::Rails::Engine
+      initializer 'biovision_regions.load_decorators' do
+        require_dependency 'biovision/regions/decorators/controllers/admin/privileges_controller_decorator'
+        require_dependency 'biovision/regions/decorators/models/user_decorator'
+        require_dependency 'biovision/regions/decorators/models/user_privilege_decorator'
+      end
+
+      config.generators do |g|
+        g.test_framework :rspec
+        g.fixture_replacement :factory_bot, :dir => 'spec/factories'
+      end
+
+      config.assets.precompile << %w(admin.scss)
+      config.assets.precompile << %w(biovision/base/**/*)
+    end
+  end
+end

data/lib/biovision/regions/privilege_methods.rb

@@ -0,0 +1,53 @@
+module Biovision
+  module Regions
+    module PrivilegeMethods
+      extend ActiveSupport::Concern
+
+      included do
+        helper_method :current_user_has_privilege?, :current_user_in_group?
+        helper_method :current_region
+      end
+
+      def current_region
+        @current_region ||= set_current_region
+      end
+
+      # @param [Symbol] privilege_name
+      # @param [Array] region_ids
+      def current_user_has_privilege?(privilege_name, region_ids = [])
+        ::UserPrivilege.user_has_privilege?(current_user, privilege_name, region_ids)
+      end
+
+      # @param [Symbol] group_name
+      def current_user_in_group?(group_name)
+        ::UserPrivilege.user_in_group?(current_user, group_name)
+      end
+
+      protected
+
+      # @param [Symbol] privilege_name
+      def require_privilege(privilege_name)
+        return if current_user_has_privilege?(privilege_name, current_region.subbranch_ids)
+        handle_http_401("Current user has no privilege #{privilege_name}")
+      end
+
+      # @param [Symbol] group_name
+      def require_privilege_group(group_name)
+        return if current_user_in_group?(group_name)
+        handle_http_401("Current user is not in group #{group_name}")
+      end
+
+      def set_current_region
+        region_slug = param_from_request(:region_slug)
+        if region_slug.blank?
+          region_slug = request.subdomains.first
+        end
+        if region_slug.blank?
+          @current_region = CentralRegion.new
+        else
+          @current_region = Region.find_by(long_slug: region_slug) || CentralRegion.new
+        end
+      end
+    end
+  end
+end

data/lib/biovision/regions/version.rb

@@ -0,0 +1,5 @@
+module Biovision
+  module Regions
+    VERSION = '0.1.180120'
+  end
+end

data/lib/biovision/regions.rb

@@ -0,0 +1,7 @@
+require "biovision/regions/engine"
+
+module Biovision
+  module Regions
+    # Your code goes here...
+  end
+end

data/lib/tasks/biovision/regions_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :biovision_regions do
+#   # Task goes here
+# end