gruff 0.12.2 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea00c2968e40f335c5505b4ce5461fb9b5ec6488bfe48293829848fd2c57e2fc
-  data.tar.gz: 860569d2e37c2b14aee89671d2bd4e76b409221a8e54712008009000c054a144
+  metadata.gz: b01a0cdd72f20c5aad3a39aed50fefd42a006b3dba14656df9356ef29ce1b43d
+  data.tar.gz: 15800ffcd4c4f06dc9e4569ebfa18ec8f551164bfc78e66aadb9b37d2e8cd312
 SHA512:
-  metadata.gz: ec50aef23be4941687dc0822b02aec8daf083f1986f50054cae56562937c1788c4e6ff4f03bff6689732b3e88787fbbf42ea3bc6324d89f4b47dddfed23bbcb3
-  data.tar.gz: 87d063e7f87081ad123e47610d173dc62e4f3c6200887021af40d389b39892b20b34d73757989eae383447308e34598198e47af33a48d1a184738c4a275361b9
+  metadata.gz: 92cfceb4d4b45f896352b6a1c06015bb468c8e2fa641271bbd8608431b455cb2b8d5730c344545f2067c90cc4e7ac4c48fbb68f950b569cf06e949490e48f299
+  data.tar.gz: 64b3436e681a3b8904e1c17729d51f1eb4693759afce386b81fed1a1d2d82ba3a1351597b7454a28cedc9dc3cac4eb740ee6c49e2e36938b732ef8d4509d65e3

data/.gitignore

@@ -1,6 +1,7 @@
 *~
 /.idea/
 /pkg/
+/coverage/
 /vendor/
 /test/output/
 /test/output_java/

data/.rubocop.yml

@@ -107,6 +107,9 @@ Style/NumericPredicate:
 Style/OptionHash:
   Enabled: false
 
+Style/RedundantBegin:
+  Enabled: false
+
 Style/SingleLineBlockParams:
   Enabled: false
 

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2021-03-07 06:12:58 UTC using RuboCop version 1.11.0.
+# on 2021-05-07 13:38:24 UTC using RuboCop version 1.12.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -49,10 +49,10 @@ Lint/Void:
   Exclude:
     - 'lib/gruff/patch/rmagick.rb'
 
-# Offense count: 54
+# Offense count: 56
 # Configuration parameters: IgnoredMethods, CountRepeatedAttributes.
 Metrics/AbcSize:
-  Max: 82
+  Max: 75
 
 # Offense count: 1
 # Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
@@ -60,17 +60,17 @@ Metrics/AbcSize:
 Metrics/BlockLength:
   Max: 29
 
-# Offense count: 13
+# Offense count: 14
 # Configuration parameters: CountComments, CountAsOne.
 Metrics/ClassLength:
-  Max: 637
+  Max: 669
 
-# Offense count: 9
+# Offense count: 8
 # Configuration parameters: IgnoredMethods.
 Metrics/CyclomaticComplexity:
   Max: 21
 
-# Offense count: 121
+# Offense count: 126
 # Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
 Metrics/MethodLength:
   Max: 81
@@ -80,7 +80,7 @@ Metrics/MethodLength:
 Metrics/ParameterLists:
   Max: 7
 
-# Offense count: 8
+# Offense count: 7
 # Configuration parameters: IgnoredMethods.
 Metrics/PerceivedComplexity:
   Max: 22
@@ -151,7 +151,7 @@ Style/DocumentDynamicEvalDefinition:
   Exclude:
     - 'test/gruff_test_case.rb'
 
-# Offense count: 132
+# Offense count: 137
 # Configuration parameters: RequireForNonPublicMethods.
 Style/DocumentationMethod:
   Enabled: false
@@ -180,11 +180,3 @@ Style/StringConcatenation:
   Exclude:
     - 'lib/gruff/photo_bar.rb'
     - 'test/gruff_test_case.rb'
-
-# Offense count: 2
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: forbid_mixed_logical_operators, forbid_logical_operators
-Style/UnlessLogicalOperators:
-  Exclude:
-    - 'lib/gruff/bar.rb'
-    - 'lib/gruff/scatter.rb'

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Change Log
 
+## 0.13.0
+- Allow to customize label value with lambda (#510)
+- Rename enable_vertical_line_markers attribute to show_vertical_markers (#509)
+- Fix error that cause ArgumentError with x_axis_increment in Gruff::Scatter (#506)
+- Fix draw_label that it should follow label_truncation_style setting (#505)
+- Deprecate use_data_label attribute from SideBar (#504)
+- Add negative values graph support in Gruff::SideBar (#499)
+- Add margin of axis in order to avoid overwriting the coordinate axes (#497)
+- Fix get_type_metrics error (#496)
+- Embed Roboto as default font (#495)
+- Fix legend rendering position when it enable legend_at_bottom (#492)
+
 ## 0.12.2
 - Avoid SEGV caused with '%S' in Draw#get_type_metrics by old ImageMagick (6.9.9 or below)  (#490)
 

data/README.md

@@ -28,6 +28,9 @@ Or install it yourself as:
 $ gem install gruff
 ```
 
+## Font
+Gruff uses [Roboto](https://fonts.google.com/specimen/Roboto) font as default font which is licensed under the Apache License, Version 2.0.
+
 ## Usage
 
 ```ruby
@@ -133,7 +136,7 @@ http://www.rubydoc.info/github/topfunky/gruff/frames
 We aim to support all Ruby implementations supporting Ruby language level 1.9.3
 or later.  Currently we are running CI for MRI, JRuby, and Rubinius.
 
-## Development Setup
+## Development
 1. Build docker image
 ```sh
 $ ./docker/build.sh
@@ -150,6 +153,12 @@ $ bundle install
 $ bundle exec rake
 ```
 
+If you have made changes that involve updating the expected image, you need to update the image with the following command after running tests.
+
+```sh
+$ bundle exec rake test:image:update
+```
+
 ## Contributing
 
 ### Source

data/assets/fonts/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/gruff.gemspec

@@ -29,8 +29,8 @@ Gem::Specification.new do |s|
     s.add_dependency 'rmagick4j'
   else
     s.add_dependency 'rmagick'
-    s.add_development_dependency 'rubocop', '~> 1.11.0'
-    s.add_development_dependency 'rubocop-performance', '~> 1.10.1'
+    s.add_development_dependency 'rubocop', '~> 1.12.1'
+    s.add_development_dependency 'rubocop-performance', '~> 1.10.2'
   end
   s.add_dependency 'histogram'
   s.required_ruby_version = '>= 2.4.0'
@@ -38,5 +38,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rake'
   s.add_development_dependency 'parallel'
   s.add_development_dependency 'minitest-reporters'
+  s.add_development_dependency 'simplecov'
   s.add_development_dependency 'yard', '~> 0.9.25'
 end

data/lib/gruff.rb

@@ -13,7 +13,7 @@ require 'gruff/version'
 
   helper/bar_conversion.rb
   helper/stacked_mixin
-  helper/bar_value_label_mixin
+  helper/bar_value_label
 
   themes
   area

data/lib/gruff/bar.rb

@@ -16,15 +16,13 @@
 #   g.write('bar.png')
 #
 class Gruff::Bar < Gruff::Base
-  using String::GruffCommify
-
   # Spacing factor applied between bars.
   attr_writer :bar_spacing
 
   # Spacing factor applied between a group of bars belonging to the same label.
   attr_writer :group_spacing
 
-  # Set the number output format for labels using sprintf.
+  # Set the number output format string or lambda.
   # Default is +"%.2f"+.
   attr_writer :label_formatting
 
@@ -83,6 +81,9 @@ protected
     hide_labels?
   end
 
+  # Value to avoid completely overwriting the coordinate axis
+  AXIS_MARGIN = 0.5
+
   def draw_bars
     # Setup spacing.
     #
@@ -93,24 +94,10 @@ protected
     padding = (bar_width * (1 - @bar_spacing)) / 2
 
     # Setup the BarConversion Object
-    conversion = Gruff::BarConversion.new
-    conversion.graph_height = @graph_height
-    conversion.graph_top = @graph_top
-
-    # Set up the right mode [1,2,3] see BarConversion for further explanation
-    if minimum_value >= 0
-      # all bars go from zero to positive
-      conversion.mode = 1
-    elsif maximum_value <= 0
-      # all bars go from 0 to negative
-      conversion.mode = 2
-    else
-      # bars either go from zero to negative or to positive
-      conversion.mode = 3
-      conversion.spread = @spread
-      conversion.minimum_value = minimum_value
-      conversion.zero = -minimum_value / @spread
-    end
+    conversion = Gruff::BarConversion.new(
+      top: @graph_top, bottom: @graph_bottom,
+      minimum_value: minimum_value, maximum_value: maximum_value, spread: @spread
+    )
 
     # iterate over all normalised data
     store.norm_data.each_with_index do |data_row, row_index|
@@ -122,11 +109,11 @@ protected
         left_x = @graph_left + (bar_width * (row_index + point_index + ((store.length - 1) * point_index))) + padding + group_spacing
         right_x = left_x + bar_width * @bar_spacing
         # y
-        left_y, right_y = conversion.get_left_y_right_y_scaled(data_point)
+        left_y, right_y = conversion.get_top_bottom_scaled(data_point)
 
         # create new bar
         rect_renderer = Gruff::Renderer::Rectangle.new(color: data_row.color)
-        rect_renderer.render(left_x, left_y, right_x, right_y)
+        rect_renderer.render(left_x, left_y - AXIS_MARGIN, right_x, right_y - AXIS_MARGIN)
 
         # Calculate center based on bar_width and current row
         label_center = @graph_left + group_spacing + (store.length * bar_width * point_index) + (store.length * bar_width / 2.0)
@@ -134,10 +121,10 @@ protected
         # Subtract half a bar width to center left if requested
         draw_label(label_center, point_index)
         if @show_labels_for_bar_values
-          raw_value = store.data[row_index].points[point_index]
-          val = (@label_formatting || '%.2f') % raw_value
-          y = raw_value >= 0 ? left_y - 30 : left_y + 12
-          draw_value_label(left_x + (right_x - left_x) / 2, y, val.commify, true)
+          bar_value_label = Gruff::BarValueLabel::Bar.new([left_x, left_y, right_x, right_y], store.data[row_index].points[point_index])
+          bar_value_label.prepare_rendering(@label_formatting, bar_width) do |x, y, text|
+            draw_value_label(x, y, text, true)
+          end
         end
       end
     end