biovision-regions 0.1.180120

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 56e46f0c1c879478cd508c894658d3e4b0c530dc4a73007ab6261bbd5dab7d12
+  data.tar.gz: fffd17eb6cb04b86a2438cea3fa951067213ec315eba598ec85aca62af0cc601
+SHA512:
+  metadata.gz: 4f45f1333cad9b829a4e0e687afcb36c112533eedf231d027210b9f7fd67104fcb2cb100712716af5a4942dfe4fcbc7c90fedfc633e7a105850e1b4bece17a57
+  data.tar.gz: 005ae18487f205491ba677f7163fdd1d34d317c0ce8ed162e3ee0648026742aa2fd65ad2a33d78529bf853fe56f1cf35635136bea95665237d52be8a1b9882df

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 Maxim Khan-Magomedov
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,28 @@
+# Biovision::Regions
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'biovision-regions'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install biovision-regions
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,26 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Biovision::Regions'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/test_app/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+require 'bundler/gem_tasks'
+

data/app/assets/config/biovision_regions_manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ../javascripts/biovision/regions .js
+//= link_directory ../stylesheets/biovision/regions .css

data/app/assets/images/biovision/regions/placeholders/region_image.svg

@@ -0,0 +1 @@
+<?xml version="1.0" ?><svg height="24" version="1.1" width="24" xmlns="http://www.w3.org/2000/svg" xmlns:cc="http://creativecommons.org/ns#" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"><g transform="translate(0 -1028.4)"><path d="m3 1031.4v10c0 4.2 3.6322 8 9 10 5.368-2 9-5.8 9-10v-10h-18z" fill="#7f8c8d"/><path d="m3 1030.4v10c0 4.2 3.6322 8 9 10 5.368-2 9-5.8 9-10v-10h-18z" fill="#bdc3c7"/><path d="m3 1030.4v10c0 4.2 3.6322 8 9 10v-20h-9z" fill="#95a5a6"/><path d="m5 1032.4v8c0 3.4 2.8251 6.4 7 8 4.175-1.6 7-4.6 7-8v-8h-14z" fill="#ecf0f1"/><path d="m5 1040.4c0 3.4 2.8251 6.4 7 8v-8h-7z" fill="#2980b9"/><rect fill="#3498db" height="8" transform="translate(0 1028.4)" width="7" x="12" y="4"/><rect fill="#bdc3c7" height="8" transform="translate(0 1028.4)" width="7" x="5" y="4"/></g></svg>

data/app/assets/javascripts/biovision/regions/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/stylesheets/biovision/regions/regions.scss

@@ -0,0 +1,25 @@
+$border-primary: .1rem solid #777 !default;
+
+form {
+  #region-image {
+    img {
+      border: $border-primary;
+      max-height: 11rem;
+      width: 11rem;
+    }
+  }
+}
+
+.privileges {
+  &.regions {
+    margin: 0 0 0 1.2rem;
+    padding: 0;
+    border: none;
+
+    > li {
+      list-style: none;
+      margin: 0;
+      padding: 0;
+    }
+  }
+}

data/app/controllers/admin/regions_controller.rb

@@ -0,0 +1,29 @@
+class Admin::RegionsController < AdminController
+  include ToggleableEntity
+  include LockableEntity
+  include EntityPriority
+
+  before_action :set_entity, except: [:index]
+
+  # get /admin/regions
+  def index
+    @collection = Region.for_tree
+  end
+
+  # get /admin/regions/:id
+  def show
+  end
+
+  private
+
+  def restrict_access
+    require_privilege_group :region_managers
+  end
+
+  def set_entity
+    @entity = Region.find_by(id: params[:id])
+    if @entity.nil?
+      handle_http_404("Cannot find region #{params[:id]}")
+    end
+  end
+end

data/app/controllers/biovision/regions/application_controller.rb

@@ -0,0 +1,7 @@
+module Biovision
+  module Regions
+    class ApplicationController < ActionController::Base
+      protect_from_forgery with: :exception
+    end
+  end
+end

data/app/controllers/regions_controller.rb

@@ -0,0 +1,73 @@
+class RegionsController < AdminController
+  before_action :set_entity, only: [:edit, :update, :destroy]
+  before_action :restrict_editing, only: [:edit, :update, :destroy]
+
+  # post /regions
+  def create
+    @entity = Region.new(creation_parameters)
+    if @entity.save
+      cache_relatives
+      redirect_to admin_region_path(@entity)
+    else
+      render :new, status: :bad_request
+    end
+  end
+
+  # get /regions/:id/edit
+  def edit
+  end
+
+  # patch /regions/:id
+  def update
+    if @entity.update(entity_parameters)
+      cache_relatives
+      redirect_to admin_region_path(@entity), notice: t('regions.update.success')
+    else
+      render :edit, status: :bad_request
+    end
+  end
+
+  # delete /post_categories/:id
+  def destroy
+    if @entity.destroy
+      flash[:notice] = t('regions.destroy.success')
+    end
+    redirect_to admin_regions_path
+  end
+
+  protected
+
+  def restrict_access
+    require_privilege_group :region_managers
+  end
+
+  def set_entity
+    @entity = Region.find_by(id: params[:id])
+    if @entity.nil?
+      handle_http_404('Cannot find region')
+    end
+  end
+
+  def restrict_editing
+    if @entity.locked? || !@entity.editable_by?(current_user)
+      redirect_to admin_region_path(@entity.id), alert: t('regions.edit.forbidden')
+    end
+  end
+
+  def entity_parameters
+    params.require(:region).permit(Region.entity_parameters)
+  end
+
+  def creation_parameters
+    params.require(:region).permit(Region.creation_parameters)
+  end
+
+  def cache_relatives
+    @entity.cache_parents!
+    unless @entity.parent.blank?
+      parent = @entity.parent
+      parent.cache_children!
+      parent.save
+    end
+  end
+end

data/app/helpers/biovision/regions/application_helper.rb

@@ -0,0 +1,6 @@
+module Biovision
+  module Regions
+    module ApplicationHelper
+    end
+  end
+end

data/app/helpers/biovision_regions_helper.rb

@@ -0,0 +1,22 @@
+module BiovisionRegionsHelper
+  # @param [Region] entity
+  def admin_region_link(entity)
+    link_to(entity.name, admin_region_path(entity.id))
+  end
+
+  # @param [Region] entity
+  def region_image_preview(entity)
+    unless entity.image.blank?
+      versions = "#{entity.image.preview_2x.url} 2x"
+      image_tag(entity.image.preview.url, alt: entity.name, srcset: versions)
+    end
+  end
+
+  # @param [Region] entity
+  def region_image_medium(entity)
+    unless entity.image.blank?
+      versions = "#{entity.image.medium_2x.url} 2x"
+      image_tag(entity.image.medium.url, alt: entity.name, srcset: versions)
+    end
+  end
+end

data/app/jobs/biovision/regions/application_job.rb

@@ -0,0 +1,6 @@
+module Biovision
+  module Regions
+    class ApplicationJob < ActiveJob::Base
+    end
+  end
+end

data/app/mailers/biovision/regions/application_mailer.rb

@@ -0,0 +1,8 @@
+module Biovision
+  module Regions
+    class ApplicationMailer < ActionMailer::Base
+      default from: 'from@example.com'
+      layout 'mailer'
+    end
+  end
+end

data/app/models/application_record.rb

@@ -0,0 +1,3 @@
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end

data/app/models/biovision/regions/application_record.rb

@@ -0,0 +1,7 @@
+module Biovision
+  module Regions
+    class ApplicationRecord < ActiveRecord::Base
+      self.abstract_class = true
+    end
+  end
+end

data/app/models/central_region.rb

@@ -0,0 +1,53 @@
+class CentralRegion
+  def id
+    nil
+  end
+
+  def name
+    I18n.t('activerecord.attributes.central_region.name')
+  end
+
+  def short_name
+    I18n.t('activerecord.attributes.central_region.short_name')
+  end
+
+  def locative
+    I18n.t('activerecord.attributes.central_region.locative')
+  end
+
+  def slug
+    ''
+  end
+
+  def long_slug
+    ''
+  end
+
+  def image
+    nil
+  end
+
+  def header_image
+    nil
+  end
+
+  def parents
+    []
+  end
+
+  def parent
+    nil
+  end
+
+  def parent_id
+    nil
+  end
+
+  def child_regions
+    []
+  end
+
+  def subbranch_ids
+    []
+  end
+end

data/app/models/country.rb

@@ -0,0 +1,61 @@
+class Country < ApplicationRecord
+  include RequiredUniqueName
+  include Toggleable
+
+  NAME_LIMIT     = 50
+  SLUG_LIMIT     = 50
+  SLUG_PATTERN   = /\A[a-z][-a-z_]*[a-z]\z/
+  PRIORITY_RANGE = (1..999)
+
+  toggleable :visible
+
+  has_many :regions, dependent: :nullify
+
+  after_initialize :set_next_priority
+  before_validation :normalize_priority
+
+  validates_presence_of :name, :short_name, :locative, :slug
+  validates_length_of :name, maximum: NAME_LIMIT
+  validates_length_of :short_name, maximum: NAME_LIMIT
+  validates_length_of :locative, maximum: NAME_LIMIT
+  validates_length_of :slug, maximum: SLUG_LIMIT
+  validates_format_of :slug, with: SLUG_PATTERN
+
+  scope :ordered_by_priority, -> { order 'priority asc, name asc' }
+  scope :visible, -> { where(visible: true) }
+  scope :list_for_visitors, -> { visible.ordered_by_priority }
+
+  def self.page_for_administration
+    ordered_by_priority
+  end
+
+  def self.entity_parameters
+    %i(visible priority name short_name locative slug)
+  end
+
+  # @param [Integer] delta
+  def change_priority(delta)
+    new_priority = priority + delta
+    criteria     = { priority: new_priority }
+    adjacent     = self.class.find_by(criteria)
+    if adjacent.is_a?(self.class) && (adjacent.id != id)
+      adjacent.update!(priority: priority)
+    end
+    self.update(priority: new_priority)
+
+    self.class.ordered_by_priority.map { |e| [e.id, e.priority] }.to_h
+  end
+
+  private
+
+  def set_next_priority
+    if id.nil? && priority == 1
+      self.priority = self.class.maximum(:priority).to_i + 1
+    end
+  end
+
+  def normalize_priority
+    self.priority = PRIORITY_RANGE.first if priority < PRIORITY_RANGE.first
+    self.priority = PRIORITY_RANGE.last if priority > PRIORITY_RANGE.last
+  end
+end

data/app/models/region.rb

@@ -0,0 +1,141 @@
+class Region < ApplicationRecord
+  include Toggleable
+
+  SLUG_PATTERN   = /\A[a-z0-9](?:[a-z0-9\-]{0,61}[a-z0-9])?\z/
+  PER_PAGE       = 20
+  NAME_LIMIT     = 70
+  SLUG_LIMIT     = 63
+  PRIORITY_RANGE = (1..32767)
+
+  toggleable :visible
+
+  belongs_ro :country, optional: true, counter_cache: true
+  belongs_to :parent, class_name: Region.to_s, optional: true, touch: true
+  has_many :child_regions, class_name: Region.to_s, foreign_key: :parent_id
+  has_many :users, dependent: :nullify
+
+  mount_uploader :image, RegionImageUploader
+  mount_uploader :header_image, HeaderImageUploader
+
+  before_validation { self.slug = slug.to_s.downcase.strip }
+  before_validation :normalize_priority
+  before_save { self.children_cache.uniq! }
+  before_save :generate_long_slug
+  after_save { parent.cache_children! unless parent.nil? }
+  after_create :cache_parents!
+
+  validates_presence_of :name, :slug
+  validates_uniqueness_of :name, :slug, scope: [:parent_id]
+  validates_length_of :name, maximum: NAME_LIMIT
+  validates_length_of :slug, maximum: SLUG_LIMIT
+  validates_format_of :slug, with: SLUG_PATTERN
+
+  scope :ordered_by_priority, -> { order 'priority asc, name asc' }
+  scope :ordered_by_slug, -> { order('slug asc') }
+  scope :ordered_by_name, -> { order('name asc') }
+  scope :visible, -> { where(visible: true) }
+  scope :for_tree, ->(country_id = nil, parent_id = nil) { where(country_id: country_id, parent_id: parent_id).ordered_by_priority }
+  scope :siblings, ->(item) { where(country_id: item.country_id, parent_id: item.parent_id) }
+
+  # @param [Integer] page
+  def self.page_for_administration(page = 1)
+    ordered_by_name.page(page).per(PER_PAGE)
+  end
+
+  def self.entity_parameters
+    %i(name short_name locative slug visible image header_image latitude longitude)
+  end
+
+  def self.creation_parameters
+    entity_parameters + %i(country_id parent_id)
+  end
+
+  # @param [User] user
+  def editable_by?(user)
+    chief   = UserPrivilege.user_has_privilege?(user, :chief_region_manager)
+    manager = UserPrivilege.user_has_privilege?(user, :region_manager, self)
+    chief || manager
+  end
+
+  def parents
+    return [] if parents_cache.blank?
+    Region.where(id: parent_ids).order('id asc')
+  end
+
+  def parent_ids
+    parents_cache.split(',').compact
+  end
+
+  # @return [Array<Integer>]
+  def branch_ids
+    parents_cache.split(',').map(&:to_i).reject { |i| i < 1 }.uniq + [id]
+  end
+
+  # @return [Array<Integer>]
+  def subbranch_ids
+    [id] + children_cache
+  end
+
+  def depth
+    parent_ids.count
+  end
+
+  def long_name
+    return name if parents.blank?
+    "#{parents.map(&:name).join('/')}/#{name}"
+  end
+
+  def branch_name
+    return short_name if parents.blank?
+    "#{parents.map(&:short_name).join('/')}/#{short_name}"
+  end
+
+  def cache_parents!
+    return if parent.nil?
+    self.parents_cache = "#{parent.parents_cache},#{parent_id}".gsub(/\A,/, '')
+    save!
+  end
+
+  def cache_children!
+    child_regions.order('id asc').each do |child|
+      self.children_cache += [child.id] + child.children_cache
+    end
+    save!
+    parent.cache_children! unless parent.nil?
+  end
+
+  # @param [Integer] delta
+  def change_priority(delta)
+    new_priority = priority + delta
+    criteria     = { country_id: county_id, parent_id: parent_id, priority: new_priority }
+    adjacent     = self.class.find_by(criteria)
+    if adjacent.is_a?(self.class) && (adjacent.id != id)
+      adjacent.update!(priority: priority)
+    end
+    self.update(priority: new_priority)
+
+    self.class.for_tree(country_id, parent_id).map { |e| [e.id, e.priority] }.to_h
+  end
+
+  private
+
+  def set_next_priority
+    if id.nil? && priority == 1
+      self.priority = self.class.siblings(self).maximum(:priority).to_i + 1
+    end
+  end
+
+  def normalize_priority
+    self.priority = PRIORITY_RANGE.first if priority < PRIORITY_RANGE.first
+    self.priority = PRIORITY_RANGE.last if priority > PRIORITY_RANGE.last
+  end
+
+  def generate_long_slug
+    if parents_cache.blank?
+      self.long_slug = slug
+    else
+      slugs          = Region.where(id: parent_ids).order('id asc').pluck(:slug) + [slug]
+      self.long_slug = slugs.join('-')
+    end
+  end
+end

data/app/uploaders/header_image_uploader.rb

@@ -0,0 +1,50 @@
+class HeaderImageUploader < CarrierWave::Uploader::Base
+  include CarrierWave::MiniMagick
+  include CarrierWave::BombShelter
+
+  storage :file
+
+  def max_pixel_dimensions
+    [4000, 4000]
+  end
+
+  # Override the directory where uploaded files will be stored.
+  # This is a sensible default for uploaders that are meant to be mounted:
+  def store_dir
+    "uploads/#{model.class.to_s.underscore}/#{mounted_as}/#{model.id}"
+  end
+
+  # Provide a default URL as a default if there hasn't been a file uploaded:
+  # def default_url
+  #   # For Rails 3.1+ asset pipeline compatibility:
+  #   # ActionController::Base.helpers.asset_path("fallback/" + [version_name, "default.png"].compact.join('_'))
+  #
+  #   "/images/fallback/" + [version_name, "default.png"].compact.join('_')
+  # end
+
+  resize_to_limit 1000, 1000
+
+  version :medium do
+    resize_to_fit 500, 500
+  end
+
+  version :preview_2x, from_version: :medium do
+    resize_to_fit 160, 160
+  end
+
+  version :preview, from_version: :preview_2x do
+    resize_to_fit 80, 80
+  end
+
+  # Add a white list of extensions which are allowed to be uploaded.
+  # For images you might use something like this:
+  def extension_whitelist
+    %w(jpg jpeg png)
+  end
+
+  # Override the filename of the uploaded files:
+  # Avoid using model.id or version_name here, see uploader/store.rb for details.
+  # def filename
+  #   "something.jpg" if original_filename
+  # end
+end

data/app/uploaders/region_image_uploader.rb

@@ -0,0 +1,53 @@
+class RegionImageUploader < CarrierWave::Uploader::Base
+  include CarrierWave::MiniMagick
+  include CarrierWave::BombShelter
+
+  def max_pixel_dimensions
+    [2000, 2000]
+  end
+
+  storage :file
+
+  # Override the directory where uploaded files will be stored.
+  # This is a sensible default for uploaders that are meant to be mounted:
+  def store_dir
+    "uploads/#{model.class.to_s.underscore}/#{mounted_as}/#{model.id}"
+  end
+
+  # Provide a default URL as a default if there hasn't been a file uploaded:
+  # def default_url
+  #   # For Rails 3.1+ asset pipeline compatibility:
+  #   # ActionController::Base.helpers.asset_path("fallback/" + [version_name, "default.png"].compact.join('_'))
+  #
+  #   "/images/fallback/" + [version_name, "default.png"].compact.join('_')
+  # end
+
+  version :header_2x do
+    resize_to_fit 220, 220
+  end
+
+  version :header, from_version: :header_2x do
+    resize_to_fit 110, 110
+  end
+
+  version :preview_2x, from_version: :header_2x do
+    resize_to_fit 160, 160
+  end
+
+  version :preview, from_version: :preview_2x do
+    resize_to_fit 80, 80
+  end
+
+  # Add a white list of extensions which are allowed to be uploaded.
+  # For images you might use something like this:
+  def extension_whitelist
+    %w(jpg jpeg png)
+  end
+
+  # Override the filename of the uploaded files:
+  # Avoid using model.id or version_name here, see uploader/store.rb for details.
+  # def filename
+  #   "something.jpg" if original_filename
+  # end
+
+end

data/app/views/admin/admin/privileges/entity/_region.html.erb

@@ -0,0 +1,12 @@
+<div>
+  <% element_id = "user_privilege_#{privilege.id}_#{region.id}" %>
+  <%= check_box_tag element_id, region.id, false, class: 'privilege-adder' %>
+  <%= label_tag element_id, region.name %>
+</div>
+<% if region.children_cache.any? %>
+    <ul class="regions" data-url="<%= regions_admin_privilege_path(privilege.id, parent_id: region.id, user_id: user.id) %>">
+      <li>
+        <button class="add_regions" type="button"><%= t('.deeper_level') %></button>
+      </li>
+    </ul>
+<% end %>