biovision-taxonomy 0.1.210504.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7f4b05dc13d14885e528eea648337050e5debf78d767bb8e858719004ff90f95
+  data.tar.gz: fc899ccb4fd9fe2b70abe9e4dc4e72a39e30047dbfde7eeba3a44020f9eda072
+SHA512:
+  metadata.gz: da75a24e4062a6aa6e39eb69b3dfd43399e25ccac1dba09982dee43b79932a759ed31e85a461cb1c1b1c7c424d9ef8960e8e2db642fc6861b91c2a268b0fea99
+  data.tar.gz: 498de657adb503de3aa820486d0aa419015230bbf21d682eaacfc06c3d3d650aa5a308182a718675e0cf5841dc1d33b5ad263c050107e6aacf5dfd7c5d27de5f

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2021 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::Taxonomy
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'biovision-taxonomy'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install biovision-taxonomy
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("spec/test_app/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

data/app/controllers/admin/taxa_controller.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+# Handling taxa
+class Admin::TaxaController < AdminController
+  include CrudEntities
+  include ToggleableEntity
+
+  before_action :set_entity, except: %i[check create index new search]
+
+  private
+
+  def component_class
+    Biovision::Components::TaxonomyComponent
+  end
+end

data/app/lib/biovision/components/taxonomy_component.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Biovision
+  module Components
+    # Taxonomy
+    class TaxonomyComponent < BaseComponent
+      def self.dependent_models
+        [Taxon, TaxonUser, TaxonComponent]
+      end
+
+      def use_images?
+        true
+      end
+
+      def administrative_parts
+        %w[taxa]
+      end
+
+      def crud_table_names
+        %w[taxa]
+      end
+
+      def role_tree
+        super.merge({ Taxon.table_name => %w[users components] })
+      end
+    end
+  end
+end

data/app/models/taxon.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+# Taxon
+#
+# Attributes:
+#   children_cache [Array<integer>]
+#   created_at [DateTime]
+#   data [jsonb]
+#   name [string]
+#   nav_text [string]
+#   object_count [integer]
+#   parent_id [integer], optional
+#   parents_cache [string]
+#   priority [integer]
+#   simple_image_id [SimpleImage], optional
+#   slug [string]
+#   updated_at [DateTime]
+#   uuid [uuid]
+#   visible [boolean]
+class Taxon < ApplicationRecord
+  include Checkable
+  include HasSimpleImage
+  include HasUuid
+  include NestedPriority
+  include Toggleable
+  include TreeStructure
+
+  SLUG_LIMIT = 50
+
+  toggleable :visible
+
+  has_many :taxon_users, dependent: :delete_all
+
+  validates_presence_of :name
+  validates_uniqueness_of :slug, scope: :parent_id
+
+  scope :ordered_by_name, -> { order('name asc') }
+  scope :visible, -> { where(visible: true) }
+  scope :list_for_administration, ->(v = nil) { where(parent_id: v).ordered_by_priority }
+  scope :seacrh, ->(q) { where('name ilike ?', "#{q}%") unless q.blank? }
+
+  # @param [Taxon] entity
+  def self.siblings(entity)
+    where(parent_id: entity&.parent_id)
+  end
+
+  def self.entity_parameters
+    %i[name nav_text priority simple_image_id slug visible]
+  end
+
+  def self.creation_parameters
+    entity_parameters + %i[parent_id]
+  end
+
+  def text_for_link
+    nav_text.blank? ? name : nav_text
+  end
+
+  def long_name
+    (parents.map(&:name) + [text_for_link]).join('/')
+  end
+end

data/app/models/taxon_component.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+# Taxon available to BiovisionComponent
+#
+# Attributes:
+#   biovision_component_id [BiovisionComponent]
+#   taxon_id [Taxon]
+class TaxonComponent < ApplicationRecord
+  belongs_to :taxon
+  belongs_to :biovision_component
+
+  validates_uniqueness_of :biovision_component_id, scope: :taxon_id
+end

data/app/models/taxon_user.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+# Taxon available to user
+#
+# Attributes:
+#   data [JSONb]
+#   user_id [User]
+#   taxon_id [Taxon]
+class TaxonUser < ApplicationRecord
+  include HasOwner
+
+  belongs_to :taxon
+  belongs_to :user
+
+  validates_uniqueness_of :taxon_id, scope: :user_id
+end

data/app/views/admin/taxa/_form.html.erb

@@ -0,0 +1,19 @@
+<%= form_with(**Biovision::Components::BaseComponent.form_options(entity)) do |f| %>
+  <%= render partial: 'shared/list_of_errors', locals: { entity: entity } %>
+
+  <dl class="fields">
+    <%= render partial: 'shared/entity/parent', locals: { entity: entity } %>
+    <%= render partial: 'shared/forms/priority', locals: { f: f } %>
+    <%= render partial: 'shared/forms/fields', locals: { f: f, fields: %w[slug name nav_text] } %>
+    <%= render partial: 'shared/forms/text_field', locals: { f: f, field: :token } unless entity.id.nil? %>
+    <%= render partial: 'shared/forms/simple_image', locals: { f: f } %>
+  </dl>
+
+  <%= render 'shared/forms/state_container' %>
+
+  <div class="buttons">
+    <%= hidden_field_tag :entity_id, entity.id %>
+    <%= f.hidden_field :parent_id if entity.id.nil? %>
+    <%= f.button t(:save), class: 'button button-save' %>
+  </div>
+<% end %>

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

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

data/app/views/admin/taxa/_taxon.jbuilder

@@ -0,0 +1,31 @@
+json.id taxon.id
+json.type taxon.class.table_name
+json.attributes do
+  json.call(taxon, :name, :slug, :nav_text, :parent_id, :parents_cache, :children_cache)
+end
+json.meta do
+  json.text_for_link taxon.text_for_link
+  json.html(
+    render(
+      partial: 'admin/taxa/entity/in_search',
+      locals: { entity: taxon },
+      formats: [:html]
+    )
+  )
+end
+json.links do
+  json.self admin_taxon_path(id: taxon.id)
+end
+unless taxon.parent.nil?
+  json.relationships do
+    json.parent do
+      json.data do
+        json.id taxon.parent_id
+        json.type taxon.parent.class.table_name
+      end
+      json.links do
+        json.self admin_taxon_path(id: taxon.parent_id)
+      end
+    end
+  end
+end

data/app/views/admin/taxa/entity/_add_child.html.erb

@@ -0,0 +1,5 @@
+<section>
+  <h2><%= t('.heading') %></h2>
+
+  <%= render partial: 'admin/taxa/form', locals: { entity: entity } %>
+</section>

data/app/views/admin/taxa/entity/_children.html.erb

@@ -0,0 +1,12 @@
+<% if collection.any? %>
+  <section>
+    <h2><%= t('.heading') %></h2>
+
+    <%=
+      render(
+        partial: 'shared/admin/list_with_priority',
+        locals: { collection: collection, handler: handler }
+      )
+    %>
+  </section>
+<% end %>

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

@@ -0,0 +1,17 @@
+<figure class="image"><%= simple_image_preview(entity) %></figure>
+<div class="data">
+  <div><%= admin_entity_link(entity) %></div>
+  <div class="info"><%= entity.name %></div>
+  <div class="secondary info"><%= t(:object_count, count: entity.object_count) %></div>
+  <div class="secondary info"><%= entity.uuid %></div>
+
+  <%= render(partial: 'shared/admin/toggle', locals: { entity: entity }) %>
+
+  <% if local_assigns[:handler] && handler.permit?('edit', entity) %>
+    <div class="entity-actions">
+      <%= edit_icon(entity) %>
+      <%= render(partial: 'shared/admin/priority', locals: { entity: entity }) %>
+      <%= destroy_icon(entity) %>
+    </div>
+  <% end %>
+</div>

data/app/views/admin/taxa/entity/_in_search.html.erb

@@ -0,0 +1,4 @@
+<div class="data">
+  <div><%= admin_entity_link(entity, entity.long_name) %></div>
+  <div class="secondary info"><%= t(:object_count, count: entity.object_count) %></div>
+</div>

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

@@ -0,0 +1,29 @@
+<% content_for :meta_title, t('.title', page: current_page) %>
+<% content_for :breadcrumbs do %>
+  <%= admin_biovision_component_link(component_handler.component) %>
+  <span><%= t('admin.taxa.nav_item.text') %></span>
+<% end %>
+
+<article>
+  <h1><%= t('.heading') %></h1>
+
+  <% if component_handler.permit?('taxa.edit') %>
+    <nav class="entity-actions">
+      <%= create_icon(new_admin_taxon_path) %>
+    </nav>
+  <% end %>
+
+  <%=
+    render(
+      partial: 'admin/widgets/quick_search',
+      locals: { endpoint: search_admin_taxa_url }
+    )
+  %>
+
+  <%=
+    render(
+      partial: 'shared/admin/list_with_priority',
+      locals: { collection: @collection, handler: component_handler }
+    )
+  %>
+</article>

data/app/views/admin/taxa/search.jbuilder

@@ -0,0 +1,3 @@
+json.data @collection do |entity|
+  json.partial! entity
+end

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

@@ -0,0 +1,51 @@
+<% content_for :meta_title, t('.title', name: @entity.name) %>
+<% content_for :breadcrumbs do %>
+  <%= admin_biovision_component_link(component_handler.component) %>
+  <%= link_to(t('admin.taxa.nav_item.text'), admin_taxa_path) %>
+  <% @entity.parents.each do |parent| %>
+    <%= admin_entity_link(parent) %>
+  <% end %>
+  <span><%= @entity.name %></span>
+<% end %>
+
+<article>
+  <h1><%= @entity.name %></h1>
+
+  <% if component_handler.permit?('edit', @entity) %>
+    <nav class="entity-actions">
+      <%= edit_icon(@entity) %>
+      <%= destroy_icon(@entity) %>
+    </nav>
+  <% end %>
+
+  <dl class="fields">
+    <%= render partial: 'shared/entity/parent', locals: { entity: @entity } %>
+    <%= render partial: 'shared/entity/text_fields', locals: { entity: @entity, fields: %w[name slug nav_text] } %>
+    <%= render partial: 'shared/entity/simple_image', locals: { entity: @entity } %>
+    <%= render partial: 'shared/entity/uuid', locals: { entity: @entity } %>
+    <%= render partial: 'shared/entity/timestamps', locals: { entity: @entity } %>
+    <%= render partial: 'shared/entity/tree_caches', locals: { entity: @entity } %>
+  </dl>
+
+  <%= render(partial: 'shared/admin/toggle', locals: { entity: @entity }) %>
+
+
+  <%=
+    render(
+      partial: 'admin/taxa/entity/children',
+      locals: {
+        collection: @entity.class.list_for_administration(@entity.id),
+        handler: component_handler
+      }
+    )
+  %>
+
+  <% if component_handler.permit?('edit', @entity) %>
+    <%=
+      render(
+        partial: 'admin/taxa/entity/add_child',
+        locals: { entity: @entity.child_items.new }
+      )
+    %>
+  <% end %>
+</article>

data/config/initializers/taxonomy.rb

@@ -0,0 +1,3 @@
+ActiveSupport::Inflector.inflections(:en) do |inflect|
+  inflect.irregular 'taxon', 'taxa'
+end

data/config/locales/taxonomy-ru.yml

@@ -0,0 +1,38 @@
+ru:
+  activerecord:
+    models:
+      taxon: "Таксон"
+      taxon_component: "Таксон в компоненте"
+      taxon_user: "Таксон для пользователя"
+  attributes:
+    taxon: "Таксон"
+    taxon_id: "Таксон"
+  admin:
+    taxa:
+      destroy:
+        success: "Таксон удалён"
+      edit:
+        title: "Редактирование таксона"
+        nav_text: "Редактировать"
+        heading: "Редактирование таксона"
+      index:
+        title: "Таксоны"
+        heading: "Таксоны"
+      nav_item:
+        text: "Все таксоны"
+        description: "Управление таксонами"
+      new:
+        title: "Добавление таксона"
+        nav_text: "Создать"
+        heading: "Новый таксон"
+      show:
+        title: "Таксон «%{name}»"
+      entity:
+        add_child:
+          heading: "Добавить дочерний таксон"
+        children:
+          heading: "Дочерние таксоны"
+  biovision:
+    components:
+      taxonomy:
+        name: "Таксономия"

data/config/routes.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+Rails.application.routes.draw do
+  concern :check do
+    post :check, on: :collection, defaults: { format: :json }
+  end
+
+  concern :priority do
+    post :priority, on: :member, defaults: { format: :json }
+  end
+
+  concern :search do
+    get :search, on: :collection
+  end
+
+  concern :toggle do
+    post :toggle, on: :member, defaults: { format: :json }
+  end
+
+  namespace :admin do
+    # Taxonomy
+    resources :taxa, concerns: %i[check priority search toggle]
+  end
+end

data/db/migrate/20210504000000_create_taxonomy_component.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+# Create tables for taxonomy
+class CreateTaxonomyComponent < ActiveRecord::Migration[6.1]
+  include Biovision::Migrations::ComponentMigration
+
+  private
+
+  def create_taxa
+    create_table :taxa, comment: 'Taxa' do |t|
+      t.uuid :uuid, null: false
+      t.references :simple_image, foreign_key: { on_update: :cascade, on_delete: :nullify }
+      t.integer :parent_id
+      t.integer :object_count, default: 0, null: false
+      t.integer :priority, limit: 2, default: 1, null: false
+      t.boolean :visible, default: true, null: false
+      t.timestamps
+      t.string :name
+      t.string :nav_text
+      t.string :slug
+      t.string :parents_cache, default: '', null: false
+      t.integer :children_cache, array: true, default: [], null: false
+      t.jsonb :data, default: {}, null: false
+    end
+
+    add_index :taxa, :uuid, unique: true
+    add_index :taxa, :data, using: :gin
+    add_foreign_key :taxa, :taxa, column: :parent_id, on_update: :cascade, on_delete: :cascade
+  end
+
+  def create_taxon_users
+    create_table :taxon_users, comment: 'Taxa available to users' do |t|
+      t.references :taxon, null: false, foreign_key: { on_update: :cascade, on_delete: :cascade }
+      t.references :user, null: false, foreign_key: { on_update: :cascade, on_delete: :cascade }
+      t.jsonb :data, default: {}, null: false
+    end
+
+    add_index :taxon_users, :data, using: :gin
+  end
+
+  def create_taxon_components
+    create_table :taxon_components, comment: 'Taxa available in components' do |t|
+      t.references :taxon, null: false, foreign_key: { on_update: :cascade, on_delete: :cascade }
+      t.references :biovision_component, null: false, foreign_key: { on_update: :cascade, on_delete: :cascade }
+    end
+  end
+end

data/lib/biovision/taxonomy.rb

@@ -0,0 +1,8 @@
+require "biovision/taxonomy/version"
+require "biovision/taxonomy/engine"
+
+module Biovision
+  module Taxonomy
+    # Your code goes here...
+  end
+end

data/lib/biovision/taxonomy/engine.rb

@@ -0,0 +1,16 @@
+module Biovision
+  module Taxonomy
+    require 'biovision'
+
+    class Engine < ::Rails::Engine
+      config.generators do |g|
+        g.test_framework :rspec
+        g.fixture_replacement :factory_bot, dir: 'spec/factories'
+      end
+
+      initializer 'sample_engine.factories', after: 'factory_bot.set_factory_paths' do
+        FactoryBot.definition_file_paths << File.expand_path('../../../spec/factories', __FILE__) if defined?(FactoryBot)
+      end
+    end
+  end
+end

data/lib/biovision/taxonomy/version.rb

@@ -0,0 +1,5 @@
+module Biovision
+  module Taxonomy
+    VERSION = '0.1.210504.0'
+  end
+end

data/lib/tasks/biovision/taxonomy_tasks.rake

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

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification
+name: biovision-taxonomy
+version: !ruby/object:Gem::Version
+  version: 0.1.210504.0
+platform: ruby
+authors:
+- Maxim Khan-Magomedov
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-05-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.3
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.3
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.3.1
+- !ruby/object:Gem::Dependency
+  name: rails-i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: biovision
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: factory_bot_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Taxonomy component for biovision-based sites.
+email:
+- maxim.km@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/biovision_taxonomy_manifest.js
+- app/controllers/admin/taxa_controller.rb
+- app/lib/biovision/components/taxonomy_component.rb
+- app/models/taxon.rb
+- app/models/taxon_component.rb
+- app/models/taxon_user.rb
+- app/views/admin/taxa/_form.html.erb
+- app/views/admin/taxa/_nav_item.html.erb
+- app/views/admin/taxa/_taxon.jbuilder
+- app/views/admin/taxa/entity/_add_child.html.erb
+- app/views/admin/taxa/entity/_children.html.erb
+- app/views/admin/taxa/entity/_in_list.html.erb
+- app/views/admin/taxa/entity/_in_search.html.erb
+- app/views/admin/taxa/index.html.erb
+- app/views/admin/taxa/search.jbuilder
+- app/views/admin/taxa/show.html.erb
+- config/initializers/taxonomy.rb
+- config/locales/taxonomy-ru.yml
+- config/routes.rb
+- db/migrate/20210504000000_create_taxonomy_component.rb
+- lib/biovision/taxonomy.rb
+- lib/biovision/taxonomy/engine.rb
+- lib/biovision/taxonomy/version.rb
+- lib/tasks/biovision/taxonomy_tasks.rake
+homepage: https://github.com/Biovision/biovision-taxonomy
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/Biovision/biovision-taxonomy
+  source_code_uri: https://github.com/Biovision/biovision-taxonomy
+  changelog_uri: https://github.com/Biovision/biovision-taxonomy
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.15
+signing_key:
+specification_version: 4
+summary: Taxonomy for biovision.
+test_files: []