redmineup 1.1.4 → 1.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e16d0fd8b57ea9d77f2c2b769ee99e3f00adb3de950f2b856d206d6db9d7f66d
-  data.tar.gz: ae312cd72499e910065b8661485cb483e8798b6ed26887e18cf54660a3a8c03d
+  metadata.gz: ffc6eee33542600145eba2fd7789b0b4166fc992752e1ae73123d2b92a290588
+  data.tar.gz: 2f1bb7682cea36f0bab2481fe3e13f67e54736bd0751442d4e90652144a73589
 SHA512:
-  metadata.gz: d273c6a8db3effbdce540bdd545576020f0f57083ba686739618894d6b8599951b7bf27ecdcd6677110d1db32f761148ad0f87b83c88a996bae3ff51a5036887
-  data.tar.gz: 61df5ba9902c47fd6c1257b018c6513ac393f51d2b75095c27e5f5b6dc04bf927d6fdaca8666189262f0580afb0b0f9ec76d75d81a9e24e47bbadc4c75d23729
+  metadata.gz: 398413f2a14e103ab19db992c186d142fe7acfb31a9c90a26b56880cfa084662250dd807d362a533ede13fd2f0df00813eeefb05c9f1869a37e74158da2d4eb3
+  data.tar.gz: b344e60e5a6dc5f551da6cd17fa2a055445a3a1dbac62647a8677a07e1c06c092fe10fcce12c8e944ffb6b3b2136bac9c25a5c6416c1289af84de514d5e05afb

data/.gitignore

@@ -1,5 +1,6 @@
 /.bundle/
 /.yardoc
+/.obsidian
 /Gemfile.lock
 /_yardoc/
 /coverage/

data/README.md

@@ -1,204 +1,125 @@
-# Redmineup
-
-This gem is used at RedmineUP as a general place for shared functionality and
-assets. It contains **Chart.js** and **select2** JS libraries, various mixins
-for ActiveRecord models and other things you might find useful.
-
-Among mixins there are:
-
-* up_acts_as_draftable
-* up_acts_as_taggable
-* up_acts_as_viewable
-* up_acts_as_votable
-
+# redmineup
+
+`redmineup` is a shared gem used by RedmineUP plugins. It provides common
+ActiveRecord mixins, view helpers, assets, settings, and compatibility patches
+so plugin code stays focused on domain logic.
+
+The gem is used in production plugins such as `redmine_contacts`,
+`redmine_people`, `redmine_products`, `redmine_questions`, `redmine_drive`,
+`redmineup_tags`, `redmine_agile`, and others.
+
+## What is included
+
+- ActiveRecord mixins: `up_acts_as_taggable`, `up_acts_as_draftable`,
+  `up_acts_as_viewed`, `up_acts_as_votable`, `up_acts_as_voter`,
+  `up_acts_as_priceable`
+- Tag helpers and tag UI helpers: `tag_link`, `tag_links`, `tag_cloud_links`,
+  `tag_list_field_tag`, `FormBuilder#tag_list_field`
+- Select2 and chart integration helpers: `select2_tag`, `transform_to_select2`,
+  `redmineup_assets`, `chartjs_assets`
+- Shared endpoint for tag autocompletion:
+  `auto_complete_taggable_tags_path`
+- Money and currency formatting (`Redmineup::MoneyHelper`,
+  `Redmineup::Currency`, `Redmineup::Settings::Money`)
+- Liquid filters and drops used across RedmineUP plugins
 
 ## Installation
 
-Add it to your plugin's Gemfile:
+Add to your Redmine or plugin `Gemfile`:
+
 ```ruby
 gem 'redmineup'
 ```
 
-Then invoke the following command in your plugin's or Redmine directory:
-```
-$ bundle install
-```
-
-And now you can start using it.
-
+Install dependencies:
 
-## Usage
-### Drafts
-This module allows saving and restoring drafts for different models. To be
-saved as a draft, an instance does not need to pass the validations. Drafts
-store not only model attributes, but also associations and virtual attributes.
-A draft could be linked to a given user, so every user can manage his/her own
-drafts independent of others. A draft might have a parent instance.
-
-First of all, drafts need to be saved somewhere, so let's create a migration:
-```ruby
-class CreateDrafts < Rails.version > '5' ? ActiveRecord::Migration[5.0] : ActiveRecord::Migration
-  def change
-    ActiveRecord::Base.create_drafts_table
-  end
-end
+```bash
+bundle install
 ```
 
-Then in the Redmine directory run:
-```
-$ rake redmine:plugins:migrate
-```
+In plugin `init.rb`, guard the minimum supported version:
 
-Next, add `up_acts_as_draftable` to a model for which you want to save drafts:
 ```ruby
-class Message < ActiveRecord::Base
-  up_acts_as_draftable
-end
+requires_redmineup version_or_higher: '1.1.5'
 ```
 
-And that's it for the preparation, now you're ready to make use of drafts:
-```ruby
-# You can save message as a draft.
-Message.new(subject: 'foo').save_draft
-
-# And later restore message from the draft.
-draft = Message.drafts(nil).last
-message = draft.restore
-puts message.subject
-# => foo
-
-# Draft can be overwritten.
-message.content = 'bar'
-puts message.save_draft
-# => true
-
-# You can also save draft linked to a particular user.
-Message.new(subject: 'baz').save_draft(user: current_user)
-
-# And restore message from some user's draft.
-user_draft = Message.drafts(current_user).last
-user_message = user_draft.restore
-puts user_message.subject
-# => baz
-
-# It's also possible to restore a bunch of messages at once.
-messages = Message.drafts(current_user).restore_all
-p messages.map(&:subject)
-# => ["baz"]
-
-# When a model instance is saved, corresponding draft is removed.
-puts Message.drafts(current_user).count
-# => 1
-user_message.board_id = Board.first.id
-user_message.save!
-puts Message.drafts(current_user).count
-# => 0
-
-# Drafts will be saved only for new (not persisted) or changed instances.
-puts Message.new.save_draft
-# => true
-persisted = Message.last
-puts persisted.save_draft
-# => false
-persisted.subject = 'other subject'
-puts persisted.save_draft
-# => true
-```
+## Quick start
 
-### Tags
-This module makes it possible to tag objects.
+### 1) Add taggable behavior to a model
 
-First, create a migration:
 ```ruby
-class CreateTags < Rails.version > '5' ? ActiveRecord::Migration[5.0] : ActiveRecord::Migration
+# db/migrate/XXXXXXXXXXXX_create_tags.rb
+class CreateTags < ActiveRecord::Migration[6.1]
   def change
     ActiveRecord::Base.create_taggable_table
   end
 end
 ```
 
-Then in the Redmine directory run:
-```
-$ rake redmine:plugins:migrate
-```
-
-Next, add `up_acts_as_taggable` to a model for which you want to provide tags:
 ```ruby
-class Contact < ActiveRecord::Base
+class Contact < ApplicationRecord
   up_acts_as_taggable
 end
 ```
 
-TODO: Add examples of usage.
-
-### Viewings
-This module allows you to count views for some ActiveRecord model instances.
+### 2) Render tags using shared helpers
 
-To count views you'll need to create a migration:
 ```ruby
-class CreateViewings < Rails.version > '5' ? ActiveRecord::Migration[5.0] : ActiveRecord::Migration
-  def change
-    ActiveRecord::Base.create_viewings_table
-  end
+# helper
+def contact_tag_url(tag_name, options = {})
+  {
+    controller: 'contacts',
+    action: 'index',
+    set_filter: 1,
+    fields: [:tags],
+    values: { tags: [tag_name] },
+    operators: { tags: '=' }
+  }.merge(options)
 end
 ```
 
-To apply it, run the following in the Redmine directory:
-```
-$ rake redmine:plugins:migrate
+```erb
+<%= tag_cloud_links(Contact.available_tags(project: @project), :contact) %>
 ```
 
-Then add `up_acts_as_viewed` to a model for which you want to count views.
-```ruby
-class Question < ActiveRecord::Base
-  up_acts_as_viewed
-end
-```
+`tag_cloud_links(tags, :contact)` resolves links via `contact_tag_url(name)`.
 
-TODO: Provide some usage examples.
+### 3) Add Select2 tag editor to forms
 
-### Votes
-With this module you can make your models votable and allow users to vote.
-
-As always, create a migration first:
-```ruby
-class CreateVotes < Rails.version > '5' ? ActiveRecord::Migration[5.0] : ActiveRecord::Migration
-  def change
-    ActiveRecord::Base.create_votable_table
-  end
-end
+```erb
+<%= f.tag_list_field :tag_list, width: '95%' %>
 ```
 
-Then apply it by running the following command in the Redmine directory:
-```
-$ rake redmine:plugins:migrate
-```
+or standalone:
 
-To make a model votable, add `up_acts_as_votable` to it:
-```ruby
-class Question < ActiveRecord::Base
-  up_acts_as_votable
-end
+```erb
+<%= tag_list_field_tag 'contact[tag_list]', @contact.tag_list, taggable_type: 'Contact' %>
 ```
 
-TODO: Write about `up_acts_as_voter` and add usage examples.
+## Documentation
 
+- [ActiveRecord mixins](doc/active-record-mixins.md)
+- [Tagging and Select2 helpers](doc/tagging-and-select2.md)
+- [Assets, money, and shared utilities](doc/assets-money-and-utilities.md)
 
 ## Development
 
-If you're planning to extend this gem, you will need to install development
-dependencies. To do this, execute the following command in the project's
-directory:
-```
-$ bundle install
-```
+Install dependencies:
 
-After that you'll be able to run tests:
-```
-$ bundle exec rake test
+```bash
+bundle install
 ```
 
-SQLite in-memory database will be used by default, which is the fastest way to run tests. To run them using different database adapters, set `DB` environment variable to one of the available values — `mysql`, `postgresql`, `sqlite`. For example, to use PostgreSQL, invoke tests like so:
+Run tests:
+
+```bash
+bundle exec rake test
 ```
-$ bundle exec rake test DB=postgresql
+
+Run tests against another DB adapter:
+
+```bash
+bundle exec rake test DB=postgresql
 ```
+
+Available `DB` values: `sqlite`, `mysql`, `postgresql`.