gruff 0.6.0 → 0.11.0

data/Gemfile

@@ -1,10 +1,6 @@
-source 'http://rubygems.org'
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in gruff.gemspec
 gemspec
-
-group :test do
-  if RUBY_VERSION =~ /^1\.9\./ || RUBY_VERSION =~ /^2\./
-    gem 'minitest-reporters', '<1.0.0'
-  end
-end

data/README.md

@@ -1,27 +1,36 @@
 # Gruff Graphs
 
-[![Build Status](https://travis-ci.org/topfunky/gruff.png?branch=master)](https://travis-ci.org/topfunky/gruff)
-[![Gem Version](https://badge.fury.io/rb/gruff.png)](http://badge.fury.io/rb/gruff)
+[![Build Status](https://travis-ci.org/topfunky/gruff.svg?branch=master)](https://travis-ci.org/topfunky/gruff)
+[![Gem Version](https://badge.fury.io/rb/gruff.svg)](https://badge.fury.io/rb/gruff)
 
 A library for making beautiful graphs.
 
+Built on top of [rmagick](https://github.com/rmagick/rmagick); see its web page
+for a list of the system-level prerequisities (ImageMagick etc) and how to install them.
+
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'gruff'
+```sh
+gem 'gruff'
+```
 
 And then execute:
 
-    $ bundle
+```sh
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install gruff
+```sh
+$ gem install gruff
+```
 
 ## Usage
 
-```Ruby
+```ruby
 require 'gruff'
 g = Gruff::Line.new
 g.title = 'Wow!  Look at this!'
@@ -40,83 +49,106 @@ g.write('exciting.png')
 
 You can find many examples in the [test](https://github.com/topfunky/gruff/tree/master/test)
 directory along with their resulting charts in the
-[output](https://github.com/topfunky/gruff/tree/master/test/output) directory.
-
-You can find older examples here:  http://nubyonrails.com/pages/gruff
+[expected](https://github.com/topfunky/gruff/tree/master/test/expected) directory.
 
 ### Accumulator bar chart
 
-![Accumulator bar chart](https://raw.github.com/topfunky/gruff/master/test/output/accum_bar.png)
+![Accumulator bar chart](https://raw.github.com/topfunky/gruff/master/test/expected/accum_bar.png)
 
 ### Area chart
 
-![Area chart](https://raw.github.com/topfunky/gruff/master/test/output/area_keynote.png)
+![Area chart](https://raw.github.com/topfunky/gruff/master/test/expected/area_keynote.png)
 
 ### Bar chart
 
-![Bar chart](https://raw.github.com/topfunky/gruff/master/test/output/bar_rails_keynote.png)
+![Bar chart](https://raw.github.com/topfunky/gruff/master/test/expected/bar_rails_keynote.png)
 
 ### Bezier chart
 
 In progress!
 
-![Bezier chart](https://raw.github.com/topfunky/gruff/master/test/output/bezier_3.png)
+![Bezier chart](https://raw.github.com/topfunky/gruff/master/test/expected/bezier_3.png)
 
 ### Bullet chart
 
 In progress!
 
-![Bullet chart](https://raw.github.com/topfunky/gruff/master/test/output/bullet_greyscale.png)
+![Bullet chart](https://raw.github.com/topfunky/gruff/master/test/expected/bullet_greyscale.png)
 
 ### Dot chart
 
-![Dot chart](https://raw.github.com/topfunky/gruff/master/test/output/dot.png)
+![Dot chart](https://raw.github.com/topfunky/gruff/master/test/expected/dot.png)
 
 ### Line chart
 
-![Line chart](https://raw.github.com/topfunky/gruff/master/test/output/line_theme_rails_keynote_.png)
+![Line chart](https://raw.github.com/topfunky/gruff/master/test/expected/line_theme_rails_keynote_.png)
 
 ### LineXY chart
 
-![LineXY chart](https://raw.github.com/topfunky/gruff/master/test/output/line_xy.png)
+![LineXY chart](https://raw.github.com/topfunky/gruff/master/test/expected/line_xy.png)
 
 ### Net chart
 
-![Net chart](https://raw.github.com/topfunky/gruff/master/test/output/net_wide_graph.png)
+![Net chart](https://raw.github.com/topfunky/gruff/master/test/expected/net_wide_graph.png)
 
 ### Pie chart
 
-![Pie chart](https://raw.github.com/topfunky/gruff/master/test/output/pie_pastel.png)
+![Pie chart](https://raw.github.com/topfunky/gruff/master/test/expected/pie_pastel.png)
 
 ### Scatter chart
 
-![Scatter chart](https://raw.github.com/topfunky/gruff/master/test/output/scatter_basic.png)
+![Scatter chart](https://raw.github.com/topfunky/gruff/master/test/expected/scatter_basic.png)
 
 ### Side bar chart
 
-![Side bar chart](https://raw.github.com/topfunky/gruff/master/test/output/side_bar.png)
+![Side bar chart](https://raw.github.com/topfunky/gruff/master/test/expected/side_bar.png)
 
 ### Side stacked bar chart
 
-![Side stacked bar chart](https://raw.github.com/topfunky/gruff/master/test/output/side_stacked_bar_keynote.png)
+![Side stacked bar chart](https://raw.github.com/topfunky/gruff/master/test/expected/side_stacked_bar_keynote.png)
 
 ### Spider chart
 
-![Spider chart](https://raw.github.com/topfunky/gruff/master/test/output/spider_37signals.png)
+![Spider chart](https://raw.github.com/topfunky/gruff/master/test/expected/spider_37signals.png)
 
 ### Stacked area chart
 
-![Stacked area chart](https://raw.github.com/topfunky/gruff/master/test/output/stacked_area_keynote.png)
+![Stacked area chart](https://raw.github.com/topfunky/gruff/master/test/expected/stacked_area_keynote.png)
 
 ### Stacked bar chart
 
-![Stacked bar chart](https://raw.github.com/topfunky/gruff/master/test/output/stacked_bar_keynote.png)
+![Stacked bar chart](https://raw.github.com/topfunky/gruff/master/test/expected/stacked_bar_keynote.png)
+
+### Histogram chart
+
+![Histogram chart](https://raw.github.com/topfunky/gruff/master/test/expected/histogram.png)
 
 
 ## Documentation
 
 http://www.rubydoc.info/github/topfunky/gruff/frames
 
+## Supported Ruby Versions
+
+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
+1. Build docker image
+```sh
+$ ./docker/build.sh
+```
+
+2. Launch docker image
+```sh
+$ ./docker/launch.sh
+```
+
+3. Run tests
+```sh
+$ bundle install
+$ bundle exec rake
+```
 
 ## Contributing
 

data/Rakefile

@@ -1,218 +1,47 @@
-require 'rubygems'
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rake/testtask'
 require 'rake/clean'
 
-CLEAN << %w(pkg test/output/*)
+CLEAN.concat %w[pkg test/output/*]
 
 desc 'Run tests'
-task :default => :test
+task default: :test
 
-task :gem => :build
+task gem: :build
 
 Rake::TestTask.new
 
 namespace :test do
   desc 'Run mini tests'
-  task :mini => :clean do
+  task mini: :clean do
     Dir['test/test_mini*'].each do |file|
       system "ruby #{file}"
     end
   end
-end
-
-desc 'Generate release docs for a given milestone'
-task :release_docs do
-  raise "\n    This task requires Ruby 1.9 or newer to parse JSON as YAML.\n\n" if RUBY_VERSION == '1.8.7'
-  categories, grouped_issues, milestone, milestone_description, milestone_name = get_github_issues
-
-  puts '=' * 80
-  puts
-  release_doc = <<EOF
-Subject: [ANN] Gruff #{milestone_name} released!
-
-The Gruff team is pleased to announce the release of Gruff #{milestone_name}.
-
-New in version #{milestone_name}:
-
-#{milestone_description}
-
-#{(categories.keys & grouped_issues.keys).map do |cat|
-    "#{cat}:\n
-#{grouped_issues[cat].map { |i| wrap(%Q{* Issue ##{i['number']} #{i['title']}},2) }.join("\n")}
-    "
-  end.join("\n")}
-You can find a complete list of issues here:
-
-* https://github.com/topfunky/gruff/issues?state=closed&milestone=#{milestone}
-
-
-Installation:
-
-    gem install gruff
-
-You can find an introductory tutorial at
-https://github.com/topfunky/gruff
-
-Enjoy!
-
-
---
-The Gruff Team
-EOF
-
-  puts release_doc
-  puts
-  puts '=' * 80
-
-  unless Gem::Version.new(Gruff::VERSION).prerelease?
-    File.write('RELEASE.md', release_doc)
-  end
-end
-
-desc 'Fetch download stats form rubygems.org'
-task :stats do
-  require 'time'
-  require 'date'
-  require 'rubygems'
-  require 'uri'
-  require 'net/http'
-  require 'net/https'
-  require 'openssl'
-  require 'yaml'
-  host = 'rubygems.org'
-  base_uri = "https://#{host}/api/v1"
-  https = Net::HTTP.new(host, 443)
-  https.use_ssl = true
-  https.verify_mode = OpenSSL::SSL::VERIFY_NONE
 
-  counts_per_month = Hash.new { |h, k| h[k] = Hash.new { |mh, mk| mh[mk] = 0 } }
-  total = 0
+  desc 'Update expected image with output'
+  task :"image:update" do
+    require 'rmagick'
+    require 'fileutils'
 
-  %w{gruff}.each do |gem|
-    versions_uri = URI("#{base_uri}/versions/#{gem}.yaml")
-    req = Net::HTTP::Get.new(versions_uri.request_uri)
-    res = https.start { |http| http.request(req) }
-    versions = YAML.load(res.body).sort_by { |v| Gem::Version.new(v['number']) }
-    puts "\n#{gem}:\n#{versions.map { |v| "#{Time.parse(v['built_at']).strftime('%Y-%m-%d')} #{'%10s' % v['number']} #{v['downloads_count']}" }.join("\n")}"
+    update_expected_images = lambda do |expect_dir, output_dir|
+      Dir.glob("#{output_dir}/*.png") do |output_path|
+        file_name = File.basename(output_path)
+        expected_path = "#{expect_dir}/#{file_name}"
 
-    versions.each do |v|
-      downloads_uri = URI("#{base_uri}/versions/#{gem}-#{v['number']}/downloads/search.yaml?from=#{Time.parse(v['built_at']).strftime('%Y-%m-%d')}&to=#{Date.today}")
-      req = Net::HTTP::Get.new(downloads_uri.request_uri)
-      res = https.start { |http| http.request(req) }
-      counts = YAML.load(res.body)
-      counts.delete_if { |date_str, count| count == 0 }
-      counts.each do |date_str, count|
-        date = Date.parse(date_str)
-        counts_per_month[date.year][date.month] += count
-        total += count
-      end
-      print '.'; STDOUT.flush
-    end
-    puts
-  end
-
-  puts "\nDownloads statistics per month:"
-  years = counts_per_month.keys
-  puts "\n    #{years.map { |year| '%6s:' % year }.join(' ')}"
-  (1..12).each do |month|
-    print "#{'%2d' % month}:"
-    years.each do |year|
-      count = counts_per_month[year][month]
-      print count > 0 ? '%8d' % count : ' ' * 8
-    end
-    puts
-  end
+        expected_image = Magick::Image.read(expected_path).first
+        output_image = Magick::Image.read(output_path).first
+        _, error = expected_image.compare_channel(output_image, Magick::PeakAbsoluteErrorMetric)
 
-  puts "\nTotal: #{total}\n\n"
-
-  puts "\nRubyGems download statistics per month:"
-  years = counts_per_month.keys
-  puts '    ' + years.map { |year| '%-12s' % year }.join
-  (0..20).each do |l|
-    print (l % 10 == 0) ? '%4d' % ((20-l) * 100) : '    '
-    years.each do |year|
-      (1..12).each do |month|
-        count = counts_per_month[year][month]
-        if [year, month] == [Date.today.year, Date.today.month]
-          count *= (Date.new(Date.today.year, Date.today.month, -1).day.to_f / Date.today.day).to_i
+        if error != 0.0
+          FileUtils.copy(output_path, expected_path)
         end
-        print count > ((20-l) * 100) ? '*' : ' '
       end
     end
-    puts
-  end
-  puts '    ' + years.map { |year| '%-12s' % year }.join
-
-  puts "\nTotal: #{total}\n\n"
-end
-
 
-def get_github_issues
-  puts 'GitHub login:'
-  begin
-    require 'rubygems'
-    require 'highline/import'
-    user = ask('login   : ') { |q| q.echo = true }
-    pass = ask('password: ') { |q| q.echo = '*' }
-  rescue Exception
-    print 'user name: '; user = STDIN.gets.chomp
-    print ' password: '; pass = STDIN.gets.chomp
+    update_expected_images.call('test/expected', 'test/output')
+    update_expected_images.call('test/expected_java', 'test/output_java')
   end
-  require 'uri'
-  require 'net/http'
-  require 'net/https'
-  require 'openssl'
-  require 'yaml'
-  host = 'api.github.com'
-  base_uri = "https://#{host}/repos/topfunky/gruff"
-  https = Net::HTTP.new(host, 443)
-  https.use_ssl = true
-  https.verify_mode = OpenSSL::SSL::VERIFY_NONE
-
-  milestone_uri = URI("#{base_uri}/milestones")
-  req = Net::HTTP::Get.new(milestone_uri.request_uri)
-  req.basic_auth(user, pass)
-  res = https.start { |http| http.request(req) }
-  milestones = YAML.load(res.body).sort_by { |i| Date.parse(i['due_on']) }
-  puts milestones.map { |m| "#{'%2d' % m['number']} #{m['title']}" }.join("\n")
-
-  if defined? ask
-    milestone = ask('milestone: ', Integer) { |q| q.echo = true }
-  else
-    print 'milestone: '; milestone = STDIN.gets.chomp
-  end
-
-  uri = URI("#{base_uri}/issues?milestone=#{milestone}&state=closed&per_page=1000")
-  req = Net::HTTP::Get.new(uri.request_uri)
-  req.basic_auth(user, pass)
-  res = https.start { |http| http.request(req) }
-  issues = YAML.load(res.body).sort_by { |i| i['number'] }
-  milestone_name = issues[0] ? issues[0]['milestone']['title'] : "No issues for milestone #{milestone}"
-  milestone_description = issues[0] ? issues[0]['milestone']['description'] : "No issues for milestone #{milestone}"
-  milestone_description = milestone_description.split("\r\n").map{|l|wrap l}.join("\r\n")
-  categories = {
-      'Features' => 'feature', 'Bugfixes' => 'bug', 'Support' => 'support',
-      'Documentation' => 'documentation', 'Pull requests' => nil,
-      'Internal' => 'internal', 'Rejected' => 'rejected', 'Other' => nil
-  }
-  grouped_issues = issues.group_by do |i|
-    labels = i['labels'].map { |l| l['name'] }
-    cat = nil
-    categories.each do |k, v|
-      if labels.include? v
-        cat = k
-        break
-      end
-    end
-    cat ||= i['pull_request'] && i['pull_request']['html_url'] && 'Pull requests'
-    cat ||= 'Other'
-    cat
-  end
-  return categories, grouped_issues, milestone, milestone_description, milestone_name
 end
-
-def wrap(string, indent = 0)
-  string.scan(/\S.{0,72}\S(?=\s|$)|\S+/).join("\n" + ' ' * indent)
-end
-

data/docker/Dockerfile

@@ -0,0 +1,14 @@
+FROM ubuntu:18.04
+
+RUN apt update && apt install -y gcc libssl-dev libyaml-dev libreadline6-dev zlib1g-dev libncurses5-dev \
+    libmagickwand-dev wget git pkg-config && \
+    wget https://cache.ruby-lang.org/pub/ruby/2.7/ruby-2.7.1.tar.gz && \
+    tar xvzf ruby-2.7.1.tar.gz && \
+    cd ruby-2.7.1 && \
+    ./configure --prefix=/usr --disable-install-rdoc && \
+    make -j install && \
+    cd .. && rm -rf ruby-2.7.1 && \
+    gem install bundler -v 1.17.3 && \
+    /usr/bin/bundle config set --local path 'vendor/bundle'
+
+WORKDIR /opt/gruff

data/docker/build.sh

@@ -0,0 +1,4 @@
+#!/bin/bash
+
+script_dir=$(cd $(dirname ${BASH_SOURCE:-$0}); pwd)
+docker build -t gruff ${script_dir}

data/docker/launch.sh

@@ -0,0 +1,4 @@
+#!/bin/bash
+
+prject_dir="$(cd $(dirname ${BASH_SOURCE:-$0}); pwd)/.."
+docker run -v $prject_dir:/opt/gruff --rm -it gruff bash