Merge pull request #69 from annikoff/develop

Version 1.0.0

Author: annikoff

.hound.yml

@@ -0,0 +1,2 @@
+ruby:
+  config_file: .rubocop.yml

.rubocop.yml

@@ -0,0 +1,26 @@
+AllCops:
+  Exclude:
+    - 'db/**/*'
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+
+Metrics/AbcSize:
+  Max: 30
+
+Metrics/MethodLength:
+  Max: 25
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/PredicateName:
+  Enabled: false
+
+Lint/RescueException:
+  Enabled: false

.travis.yml

@@ -0,0 +1,51 @@
+language: ruby
+
+rvm:
+  - 2.1
+
+gemfile:
+  - $REDMINE_PATH/Gemfile
+
+env:
+  - REDMINE_VER=3.3-stable
+  - REDMINE_VER=3.2-stable
+  - REDMINE_VER=3.1-stable
+  - REDMINE_VER=3.0-stable
+  - REDMINE_VER=2.6-stable
+
+matrix:
+  include:
+  - rvm: 1.9.3
+    env: REDMINE_VER=2.5-stable
+
+before_install:
+  - export PLUGIN_NAME=computed_custom_field
+  - export REDMINE_PATH=$HOME/redmine
+  - git clone -b "$REDMINE_VER" --single-branch https://github.com/redmine/redmine.git $REDMINE_PATH
+  - ln -s $TRAVIS_BUILD_DIR $REDMINE_PATH/plugins/$PLUGIN_NAME
+  - cp config/database.yml.travis $REDMINE_PATH/config/database.yml
+  - if [[ $(ruby --version | awk '{print $2}') < 2.1 ]]; then
+    echo "gem 'nokogiri', '= 1.5.11'" >> $REDMINE_PATH/Gemfile;
+    sed -ri 's/("selenium-webdriver")/\1, "= 2.53.4"/' $REDMINE_PATH/Gemfile; fi
+  - cd $REDMINE_PATH
+  - if [[ $REDMINE_VER < '3.2-stable' ]]; then
+    echo "$(curl http://www.redmine.org/projects/redmine/repository/revisions/14891/diff/trunk/lib/tasks/redmine.rake?format=diff)" > redmine.rake.patch;
+    patch lib/tasks/redmine.rake redmine.rake.patch; fi
+  - export DISPLAY=:99.0
+  - sh -e /etc/init.d/xvfb start
+  - phantomjs --webdriver 4444 &
+
+install:
+  - bundle install --without development
+
+before_script:
+  - bundle exec rake db:create
+  - bundle exec rake db:migrate
+  - bundle exec rake redmine:plugins:migrate
+
+script:
+  - bundle exec rake redmine:plugins:test NAME=$PLUGIN_NAME
+  - bundle exec rake redmine:plugins:test:ui NAME=$PLUGIN_NAME
+
+notifications:
+  email: false

CHANGELOG.md

@@ -0,0 +1,102 @@
+# Change Log
+
+## [1.0.0](https://github.com/annikoff/redmine_plugin_computed_custom_field/releases/tag/v1.0.0) - 2017-02-15
+### Added
+- New formula constructions `cfs[cf_id]`. Thanks to [ecanuto](https://github.com/ecanuto) for the idea.
+- Tests.
+- CHANGELOG.
+- Redmine 2.5.x support.
+
+### Changed
+- Code has been rewritten from scratch.
+- No backward compatibility with older versions.
+- There is no separate computed format anymore. Custom field of any built-in format can be created as computed.
+- README.
+
+### Removed
+- Old formula constructions `%{cf_id}`.
+- Output formats.
+
+## [0.0.8](https://github.com/annikoff/redmine_plugin_computed_custom_field/releases/tag/v0.0.8) - 2016-11-27
+### Added
+- Error handling to prevent internal server errors. From [swiehr](https://github.com/swiehr).
+- zh  translation from [archonwang](https://github.com/archonwang).
+
+### Changed
+- README.
+
+### Fixed
+- Link formatting.
+
+## [0.0.7](https://github.com/annikoff/redmine_plugin_computed_custom_field/releases/tag/v0.0.7) - 2016-08-29
+### Added
+- Markdown link format support.
+- Grouping functionality for queries. From [plotterie](https://github.com/plotterie).
+
+### Changed
+- README.
+
+### Fixed
+- Typo in a custom field form. From [swiehr](https://github.com/swiehr).
+- Error when validating DateTime.
+
+## [0.0.6](https://github.com/annikoff/redmine_plugin_computed_custom_field/releases/tag/v0.0.6) - 2016-01-15
+### Added
+- Totalable support for Redmine 3.x.
+
+### Fixed
+- Error when trying to save iIssue from TimeEntry if Issue does not present.
+
+## [0.0.5](https://github.com/annikoff/redmine_plugin_computed_custom_field/releases/tag/v0.0.5) - 2015-12-21
+### Added
+- Link output format.
+- pt-br translation from [Adriano Ceccarelli](https://github.com/aceccarelli).
+
+### Changed
+- README.
+- Error message about formula computing.
+
+### Fixed
+- Exclude Document class from list of classes for a patch.
+
+## [0.0.4](https://github.com/annikoff/redmine_plugin_computed_custom_field/releases/tag/v0.0.4) - 2015-10-22
+### Added
+- Boolean and Percentage output formats.
+- TimeEntry callbacks to re-save Issue.
+- fr translation from [Atmis](https://github.com/Atmis).
+
+### Removed
+- Tests examples
+
+### Fixed
+- Bug when formula validation
+
+## [0.0.3](https://github.com/annikoff/redmine_plugin_computed_custom_field/releases/tag/v0.0.3) - 2015-09-23
+### Added
+- String and Datetime output formats.
+- Query filter options.
+
+### Fixed
+- Formula validation is evaluated in proper context.
+
+## [0.0.2](https://github.com/annikoff/redmine_plugin_computed_custom_field/releases/tag/v0.0.2) - 2015-09-20
+### Added
+- Int and Float output formats.
+- en translation.
+- es translation from [lublasco](https://github.com/lublasco).
+- Formula validation.
+
+### Changed
+- List of classes for a patch. 
+- README.
+- Excluded CF own id from available fields list.
+
+### Removed
+- Groups of custom fields from creation form.
+
+### Fixed
+- Conversion error when formula computation 
+
+## [0.0.1](https://github.com/annikoff/redmine_plugin_computed_custom_field/releases/tag/v0.0.1) - 2015-08-13
+### Added
+- Base functionality.

PluginGemfile

@@ -0,0 +1,3 @@
+group :development do
+  gem 'rubocop', require: false
+end

README.md

@@ -1,48 +1,76 @@
 ### ComputedCustomField plugin for Redmine
 
+[![Build Status](https://travis-ci.org/annikoff/redmine_plugin_computed_custom_field.svg?branch=master)](https://travis-ci.org/annikoff/redmine_plugin_computed_custom_field)
+[![Code Climate](https://codeclimate.com/github/annikoff/redmine_plugin_computed_custom_field/badges/gpa.svg)](https://codeclimate.com/github/annikoff/redmine_plugin_computed_custom_field)
+
 ### Description:
-This plugin adds a new type of Custom Field named "computed".
-The value of computed field can be set by formula.
-In formula constructions like %{cf_id} are replaced by IDs of custom fields.
-Valid formula is a valid Ruby code executed when customized object is updated.
+
+This plugin provides a possibility to create a computed custom field. 
+The value of computed field can be set by formula. 
+In formula constructions like `cfs[cf_id]` are replaced by IDs of custom fields. 
+Valid formula is a valid Ruby code executed when customized object is updated. 
 To put a field ID in the formula, double-click on an item in the list of available fields.
 
-![ComputedCustomField plugin for Redmine](https://raw.githubusercontent.com/annikoff/images/master/redmine_plugin_computed_custom_field.png "")
+
+![ComputedCustomField plugin for Redmine](https://raw.githubusercontent.com/annikoff/images/master/redmine_plugin_computed_custom_field_v_1_0_0.png)
+
+### Changelog:
+
+Plugin's changelog is available [here](CHANGELOG.md).
+
+### Important information
+
+This is a new version of the plugin. Since version 1.0.0 it is not compatible with previous versions.
+The following constructions in formula `%{cf_id}` are no longer supported. Instead use `cfs[cf_id]`.
+If you need to upgrade from older versions, please check out migration section.
 
 > ### Notes:
-> - %{cf_id} — must be an ID of existing custom field
-> - If format of Custom Field is Text, Long Text or List, you need to surround '%{cf_id}' with quotes
-> - Be careful with code in formula, if it would wrong your application can be crashed
-> - This plugin has been tested on Redmine v2.6.7 with RoR v3.2.22 and Redmine v3.1 with RoR v4.2.3
-> - There are six types of output format: "int", "float", "string", "link", "datetime", "bool", "percentage"
-> - If a computed custom field was created after creating of customized object you need to re-save an object to evaluate computations
-> - After updating of formula customized objects should be re-saved
+> - cfs[cf_id] — must be an ID of existing custom field.
+> - Be careful with code in formula, if it would wrong your application can be crashed.
+> - If a computed custom field was created after creating of customized object you need to re-save an object to evaluate computations.
+> - After updating of formula customized objects should be re-saved.
 
 ### Installation:
 
 Clone from GitHub
 ```sh
+# Latest version
 git clone https://github.com/annikoff/redmine_plugin_computed_custom_field.git computed_custom_field
 ```
 
 Or download [ZIP-archive](https://github.com/annikoff/redmine_plugin_computed_custom_field/archive/master.zip) and extract it into "computed_custom_field" directory.
 
+Run migrations
+```sh
+rake redmine:plugins:migrate
+```
+
+### Migration:
+- Navigate to plugin folder.
+- Run `git pull`
+- Run `rake redmine:plugins:migrate`
+- In computed CF's formulas replace `%{cf_id}` constructions by `cfs[cf_id]`.
+
+### Compatibility
+
+The plugins supports the following Redmine versions: 3.3.x, 3.2.x, 3.1.x, 3.0.x, 2.6.x, 2.5.x.
+
 ### Examples:
 ```ruby
-%{cf_1}*2+%{cf_2} 
+cfs[1]*2+cfs[2]
 # means 
 # custom_field_value(1) * 2 + custom_field_value(2)
 ```
 
 ```ruby
-(%{cf_1}/3.14).round(2)
+(cfs[1]/3.14).round(2)
 ```
 
 ```ruby
-if %{cf_1}.zero?
- %{cf_2}/2
+if cfs[1].zero?
+ cfs[2]/2
 else
- %{cf_3}/2
+ cfs[3]/2
 end
 ```
 
@@ -56,21 +84,11 @@ end
 self.parent_id == 2
 ```
 
-```ruby
-# If format of Custom Field with ID 4 is Text, Long Text or List
-'%{cf_4}'
-```
-
 ```ruby
 # If format of Custom Field is Link
 "/projects/#{self.project_id.to_s}/issues/new?issue[subject]=Review+request+[##{self.id.to_s} #{self.subject}]&issue[tracker_id]=3"
 ```
 
-```ruby
-# If format of Custom Field is Link, and you need to set up a specific link caption
-"'Click here for more details':/projects/#{project.try(:identifier)}/wiki"
-```
-
 To write formulas this documentation can be helpful:
 - [Issue](http://www.rubydoc.info/github/edavis10/redmine/Issue)
 - [Project](http://www.rubydoc.info/github/edavis10/redmine/Project)
@@ -81,4 +99,4 @@ To write formulas this documentation can be helpful:
 - [Document](http://www.rubydoc.info/github/edavis10/redmine/Document)
 - [TimeEntryActivity, IssuePriority, DocumentCategory](http://www.rubydoc.info/github/edavis10/redmine/Enumeration)
 
-Licensed under the [MIT-LICENSE](https://raw.githubusercontent.com/annikoff/redmine_plugin_computed_custom_field/master/MIT-LICENSE)
+Licensed under the [MIT-LICENSE](MIT-LICENSE)

app/views/formats/_computed.html.erb

@@ -0,0 +1,21 @@
+<% if custom_field.new_record? || custom_field.is_computed? %>
+  <p><%= form.check_box :is_computed,
+                        data: { enables: '#custom_field_formula, #available_cfs' },
+                        disabled: !custom_field.new_record? %></p>
+  <p><%= form.text_area :formula, rows: 7 %></p>
+  <p>
+    <%= label_tag l(:label_available_custom_fields) %>
+    <%= render_computed_custom_fields_select custom_field %>
+  </p>
+
+  <script type="text/javascript">
+      (function() {
+          $("#available_cfs").dblclick(function() {
+              var formula = $("#custom_field_formula");
+              $(this).find("option:selected").each(function() {
+                  formula.val(formula.val() + 'cfs[' + $(this).val() + ']');
+              });
+          });
+      }())
+  </script>
+<% end %>