gruff 0.15.0 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c6b8682f3d05aa7d0a91ea58fbe907aa581f9a2ed7549f28376390fc0f2101ec
-  data.tar.gz: 31dc3d1b680b887405a66d8c1d14a2baea76b549958f4cd92bf3d2a6adae8ba3
+  metadata.gz: 1b7a28fa80f8c598a927ce29242c2014a38cc21b1fc1fc43a80285239b448176
+  data.tar.gz: 13a94cca6581eebccafd48de9d48daa1acd4c085989cd996a6054fd63bfa8f8a
 SHA512:
-  metadata.gz: 5b5e6a29b5acf50408dd03a75f7acaa8830d96cf23bc02d6ac7a5ef9d713afcc41157fc2e94be8ab1611c624bc36398ba0e6793228f9ce75be009f59a9ac9f7c
-  data.tar.gz: 15766e34990536075a856d716d75f5e6d940f7bcb5d4dc9074040c82a8d418f95c0e3780bdbe36821a1c2aca66a07eaeaa11ff10622da7e29faf6347cac303af
+  metadata.gz: 165988fc75b87fcd15f789ee9b178cbbe4ddc32cd0090f62cdcd36041806223b65c59406cd855038e0881ffb0b260df146aec74de7caff5ee0fc32df01447268
+  data.tar.gz: c5dcff59b2f8ab733fc99bafee1472ab0c014fbb106bec26fca167880b585cc9e61a6cc00b4e08aa02d39a2fe92d2291a7363a13ed16673a06898edcd15fb081

data/.github/workflows/ci.yml

@@ -6,9 +6,12 @@ on:
   pull_request:
     branches: [ master ]
 
+permissions:
+  contents: read
+
 jobs:
   lint:
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-20.04
     timeout-minutes: 20
     name: Lint
     steps:
@@ -23,31 +26,44 @@ jobs:
     - name: Install dependencies
       run: bundle install --path=vendor/bundle --jobs 4 --retry 3
     - name: RuboCop Problem Matchers
-      uses: r7kamura/rubocop-problem-matchers-action@v1.1.0
+      uses: r7kamura/rubocop-problem-matchers-action@v1
     - name: Run tests
       run: bundle exec rubocop
 
   test-ruby:
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-20.04
     timeout-minutes: 20
     strategy:
       matrix:
         ruby-version: ['2.5', '2.6', '2.7', '3.0', '3.1']
+        imagemagick-version:
+          - { full: 7.1.0-39, major-minor: '7.0' }
     name: Ruby ${{ matrix.ruby-version }}
     steps:
     - uses: actions/checkout@v3
+    - name: Cache ImageMagick
+      uses: actions/cache@v3
+      with:
+        path: ./build-ImageMagick
+        key: v1-linux-imagemagick-${{ matrix.imagemagick-version.full }}
+        restore-keys: |
+          v1-linux-imagemagick-${{ matrix.imagemagick-version.full }}
+    - name: Install ImageMagick ${{ matrix.imagemagick-version.full }}
+      run: |
+        export IMAGEMAGICK_VERSION=${{ matrix.imagemagick-version.full }}
+        ./before_install_linux.sh
     - name: Set up Ruby
       uses: ruby/setup-ruby@master
       with:
         ruby-version: ${{ matrix.ruby-version }}
-        bundler-cache: true
+        bundler-cache: false
     - name: Install dependencies
       run: bundle install --path=vendor/bundle --jobs 4 --retry 3
     - name: Run tests
       run: bundle exec rake
 
   test-jruby:
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-20.04
     timeout-minutes: 20
     strategy:
       matrix:

data/.gitignore

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

data/.rubocop.yml

@@ -21,9 +21,6 @@ Gemspec/RequiredRubyVersion:
 Layout/AccessModifierIndentation:
   EnforcedStyle: outdent
 
-Layout/ClassStructure:
-  Enabled: false
-
 Layout/FirstMethodArgumentLineBreak:
   Enabled: false
 
@@ -42,9 +39,6 @@ Layout/RedundantLineBreak:
 Layout/SingleLineBlockChain:
   Enabled: false
 
-Lint/AmbiguousOperatorPrecedence:
-  Enabled: false
-
 Lint/ConstantResolution:
   Enabled: false
 
@@ -54,9 +48,6 @@ Lint/FloatComparison:
 Lint/NumberConversion:
   Enabled: false
 
-Naming/MemoizedInstanceVariableName:
-  Enabled: false
-
 Naming/MethodParameterName:
   Enabled: false
 
@@ -128,6 +119,3 @@ Style/StructInheritance:
 
 Performance/ChainArrayAllocation:
   Enabled: false
-
-Performance/StringReplacement:
-  Enabled: false

data/CHANGELOG.md

@@ -1,5 +1,57 @@
 # Change Log
 
+## 0.18.0
+- Add Gruff::Bubble (#604)
+- Rename Gruff::BoxPlot to Gruff::Box (#603)
+- Mark Gruff::Scatter#disable_significant_rounding_x_axis= as deprecated (#602)
+- Mark Gruff::Scatter#x_label_margin= as deprecated (#601)
+- Mark Gruff::Scatter#use_vertical_x_labels= as deprecated (#600)
+
+## 0.17.0
+- Add Gruff::Base#label_rotation= method to rotate bottom label (#599)
+- Mark #label_stagger_height= as deprecated (#598)
+- Fixed truncation of long legends in mini graph (#597)
+- Fix error when input empty data in Gruff::Bezier (#596)
+- Fix error when input empty data in Gruff::StackedArea (#595)
+- Fix error when input empty data in Gruff::BoxPlot (#594)
+- Fix error when input empty data in Gruff::Spider (#593)
+- Fix error when input empty data in Gruff::Histogram (#592)
+- Fix error when input empty data in Gruff::Area (#591)
+- Stop adjusting the square radius in Gruff::Line (#589)
+- Add diamond dot stype in Gruff::Line (#588)
+- Allow title to be set as an array (#587)
+- Allow labels to be set as an array corresponding to the data values (#586)
+- Fixed a bug that breaks the colors in the theme when using the add_color method (#583)
+- Ensure to raise an exception if use sort feature in Candlestick
+- Fix column_count in BoxPlot/Candlestick (#581)
+- Fix left/right graph margin (#579)
+
+## 0.16.0
+- Add Candlestick (#575)
+- Add BoxPlot (#574)
+- Raise exception if less data set was given in Gruff::Spider (#573)
+- Adjust default label offset value in Gruff::Pie
+- Remove has_left_labels from attribute (#571)
+- Remove center_labels_over_point from attribute (#570)
+- Adjust legend label / box position
+- Fix right margin when truncate the label
+- Adjust axis label position
+- Adjust left label margin
+- Fix axis label position with hide_line_markers
+- Fix margin of value label in Bar/StackedBar (#568)
+- Fix label position in Gruff::Spider (#567)
+- Fix axis label position with legend_at_bottom
+- Fix axis label position with hide_line_markers
+- Refactor: Remove instance variable usage
+- Remove Gruff::Scene (#566)
+- Fix exception with zero value in StackBar (#565)
+- Fix segment spacing in SideStackedBar (#564)
+- Fix margin of value label in SideBar/SideStackedBar (#563)
+- Raise exception if negative values were given in stacked graph (#562)
+- Fix centering in value label position (#561)
+- Fix duck typing support in Gruff::Histogram (#560)
+- Fix start drawing position to top in Pie and enabled sort option by default (#559)
+
 ## 0.15.0
 - Fix SideStackedBar which bars overlap on the coordinate axes if data contains 0 (#558)
 - Lazy loading library to reduce memory usage (#556)

data/README.md

@@ -126,6 +126,17 @@ In progress!
 
 ![Histogram chart](https://raw.github.com/topfunky/gruff/master/test/expected/histogram.png)
 
+### Box chart
+
+![Box chart](https://raw.github.com/topfunky/gruff/master/test/expected/box.png)
+
+### Candlestick
+
+![Candlestick](https://raw.github.com/topfunky/gruff/master/test/expected/candlestick.png)
+
+### Bubble chart
+
+![Bubble chart](https://raw.github.com/topfunky/gruff/master/test/expected/bubble.png)
 
 ## Documentation
 
@@ -133,7 +144,7 @@ http://www.rubydoc.info/github/topfunky/gruff/frames
 
 ## Supported Ruby Versions
 
-- Ruby 2.4 or later
+- Ruby 2.5 or later
 - JRuby 9.2.x or later
 
 ## Development
@@ -149,13 +160,13 @@ $ ./docker-launch.sh
 
 3. Run tests
 ```sh
-$ rake
+$ 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
-$ rake test:image:update
+$ bundle exec rake test:image:update
 ```
 
 ## Contributing

data/gruff.gemspec

@@ -11,12 +11,11 @@ Gem::Specification.new do |s|
   s.authors = ['Geoffrey Grosenbach', 'Uwe Kubosch']
   s.description = 'Beautiful graphs for one or multiple datasets. Can be used on websites or in documents.'
   s.email = 'boss@topfunky.com'
-  s.files = `git ls-files`.split.grep_v(/^test|^docker|^Rakefile/i)
+  s.files = `git ls-files`.split.grep_v(/^test|^docker|^before_install_linux.sh|^Rakefile/i)
   s.homepage = 'https://github.com/topfunky/gruff'
   s.require_paths = %w[lib]
   s.summary = 'Beautiful graphs for one or multiple datasets.'
   s.license = 'MIT'
-  s.test_files = s.files.grep(%r{^(test|spec|features)/})
   s.executables = s.files.grep(%r{^bin/}).map { |f| File.basename(f) }
   s.specification_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
 
@@ -25,7 +24,7 @@ Gem::Specification.new do |s|
     s.add_dependency 'rmagick4j'
   else
     s.add_dependency 'rmagick', '>= 4.2'
-    s.add_development_dependency 'rubocop', '~> 1.27.0'
+    s.add_development_dependency 'rubocop', '~> 1.28.2'
     s.add_development_dependency 'rubocop-performance', '~> 1.13.3'
     s.add_development_dependency 'rubocop-rake', '~> 0.6.0'
   end
@@ -35,7 +34,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rake'
   s.add_development_dependency 'minitest-reporters'
   s.add_development_dependency 'simplecov'
-  s.add_development_dependency 'yard', '~> 0.9.25'
+  s.add_development_dependency 'yard', '~> 0.9.28'
 
   s.metadata['rubygems_mfa_required'] = 'true'
 end

data/lib/gruff/accumulator_bar.rb

@@ -19,7 +19,7 @@ private
   def setup_data
     raise(Gruff::IncorrectNumberOfDatasetsException) unless store.length == 1
 
-    accum_array = store.data.first.points[0..-2].reduce([0]) { |a, v| a << a.last + v }
+    accum_array = store.data.first.points[0..-2].reduce([0]) { |a, v| a << (a.last + v) }
     data 'Accumulator', accum_array
     set_colors
     store.reverse!

data/lib/gruff/area.rb

@@ -30,15 +30,17 @@ private
   end
 
   def draw_graph
-    x_increment = @graph_width / (column_count - 1).to_f
+    x_increment = (@graph_width / (column_count - 1)).to_f
 
     store.norm_data.each do |data_row|
+      next if data_row.points.empty?
+
       poly_points = []
 
       data_row.points.each_with_index do |data_point, index|
         # Use incremented x and scaled y
         new_x = @graph_left + (x_increment * index)
-        new_y = @graph_top + (@graph_height - data_point * @graph_height)
+        new_y = @graph_top + (@graph_height - (data_point * @graph_height))
 
         poly_points << new_x
         poly_points << new_y
@@ -48,9 +50,9 @@ private
 
       # Add closing points, draw polygon
       poly_points << @graph_right
-      poly_points << @graph_bottom - 1
+      poly_points << (@graph_bottom - 1)
       poly_points << @graph_left
-      poly_points << @graph_bottom - 1
+      poly_points << (@graph_bottom - 1)
 
       Gruff::Renderer::Polygon.new(renderer, color: data_row.color, width: @stroke_width, opacity: @fill_opacity).render(poly_points)
     end

data/lib/gruff/bar.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative 'helper/bar_mixin'
+
 #
 # Gruff::Bar provide a bar graph that presents categorical data
 # with rectangular bars.
@@ -16,6 +18,8 @@
 #   g.write('bar.png')
 #
 class Gruff::Bar < Gruff::Base
+  include BarMixin
+
   # Spacing factor applied between bars.
   attr_writer :bar_spacing
 
@@ -33,6 +37,10 @@ class Gruff::Bar < Gruff::Base
   # Prevent drawing of column labels below a bar graph.  Default is +false+.
   attr_writer :hide_labels
 
+  # Value to avoid completely overwriting the coordinate axis
+  AXIS_MARGIN = 0.5
+  private_constant :AXIS_MARGIN
+
   # Can be used to adjust the spaces between the bars.
   # Accepts values between 0.00 and 1.00 where 0.00 means no spacing at all
   # and 1 means that each bars' width is nearly 0 (so each bar is a simple
@@ -70,15 +78,26 @@ private
   end
 
   def hide_left_label_area?
-    @hide_line_markers
+    @hide_line_markers && @y_axis_label.nil?
   end
 
   def hide_bottom_label_area?
-    hide_labels?
+    hide_labels? && @x_axis_label.nil? && @legend_at_bottom == false
   end
 
-  # Value to avoid completely overwriting the coordinate axis
-  AXIS_MARGIN = 0.5
+  def setup_graph_measurements
+    super
+    return if @hide_line_markers
+
+    if @show_labels_for_bar_values
+      if maximum_value >= 0
+        _, metrics = Gruff::BarValueLabel.metrics(maximum_value, @label_formatting, proc_text_metrics)
+        @graph_top += metrics.height
+      end
+
+      @graph_height = @graph_bottom - @graph_top
+    end
+  end
 
   def draw_graph
     # Setup spacing.
@@ -86,8 +105,8 @@ private
     # Columns sit side-by-side.
     @bar_spacing ||= @spacing_factor # space between the bars
 
-    bar_width = (@graph_width - calculate_spacing) / (column_count * store.length).to_f
-    padding = (bar_width * (1 - @bar_spacing)) / 2
+    bar_width = (@graph_width - calculate_spacing) / (column_count * store.length)
+    padding = (bar_width * (1 - @bar_spacing)) / 2.0
 
     # Setup the BarConversion Object
     conversion = Gruff::BarConversion.new(
@@ -95,34 +114,32 @@ private
       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|
-      data_row.points.each_with_index do |data_point, point_index|
-        group_spacing = @group_spacing * @scale * point_index
-
-        # Use incremented x and scaled y
-        # x
-        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_top_bottom_scaled(data_point)
-
-        # create new bar
-        rect_renderer = Gruff::Renderer::Rectangle.new(renderer, color: data_row.color)
-        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)
-
-        # Subtract half a bar width to center left if requested
-        draw_label(label_center, point_index)
-        if @show_labels_for_bar_values
-          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)
+    group_left_x = @graph_left
+
+    normalized_group_bars.each_with_index do |group_bars, group_index|
+      right_x = 0
+      group_bars.each_with_index do |bar, index|
+        left_x = group_left_x + (bar_width * index) + padding
+        right_x = left_x + (bar_width * @bar_spacing)
+
+        top_y, bottom_y = conversion.get_top_bottom_scaled(bar.point)
+        if bar.point != 0
+          rect_renderer = Gruff::Renderer::Rectangle.new(renderer, color: bar.color)
+          rect_renderer.render(left_x, bottom_y - AXIS_MARGIN, right_x, top_y)
+        end
+
+        if @show_labels_for_bar_values && bar.value
+          bar_value_label = Gruff::BarValueLabel::Bar.new([left_x, top_y, right_x, bottom_y], bar.value)
+          bar_value_label.prepare_rendering(@label_formatting, proc_text_metrics) do |x, y, text, _text_width, text_height|
+            draw_value_label(bar_width * @bar_spacing, text_height, x, y, text)
           end
         end
       end
+
+      label_center = group_left_x + ((right_x - group_left_x) / 2.0)
+      draw_label(label_center, group_index)
+
+      group_left_x = right_x + padding + @group_spacing
     end
 
     # Draw the last label if requested
@@ -130,6 +147,10 @@ private
   end
 
   def calculate_spacing
-    @scale * @group_spacing * (column_count - 1)
+    @group_spacing * (column_count - 1)
+  end
+
+  def proc_text_metrics
+    ->(text) { text_metrics(@marker_font, text) }
   end
 end