chartd 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: eab546b1677131a3af4f675d30377798e59a526a
+  data.tar.gz: 4652a53ccaf3d551fd99c1176c4d0c075a9f8463
+SHA512:
+  metadata.gz: aa4086f5cbdbac14f11107992bb9d82c4cbe8d56dd28dfe16f31e46c66c2ddba82b57c5a00477d659432ba470248eea69079fb7a160a6a77f970f3fe07754a5b
+  data.tar.gz: 47fb6bdd43be5690ace269f3b677c3535bb37acfe88fd2c66d92c0735a53895e8f97101c056420c4f75d007de2056061ddff572449caefb17176700e3cf981af

data/.editorconfig

@@ -0,0 +1,17 @@
+# EditorConfig helps developers define and maintain consistent
+# coding styles between different editors and IDEs
+# editorconfig.org
+
+root = true
+
+[*]
+
+# Change these settings to your own preference
+indent_style = space
+indent_size = 2
+
+# We recommend you to keep these unchanged
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true

data/.gitignore

@@ -0,0 +1,2 @@
+coverage/
+chartd-*.gem

data/.travis.yml

@@ -0,0 +1,12 @@
+sudo: false
+language: ruby
+
+rvm:
+  - 2.2.4
+  - 2.3.0
+  - ruby-head
+
+cache: bundler
+
+notifications:
+  email: false

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,31 @@
+PATH
+  remote: .
+  specs:
+    chartd (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    docile (1.1.5)
+    json (2.0.2)
+    power_assert (0.3.0)
+    rake (11.2.2)
+    simplecov (0.12.0)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    test-unit (3.2.1)
+      power_assert
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  chartd!
+  rake (~> 11.2)
+  simplecov (~> 0.12)
+  test-unit (~> 3.2)
+
+BUNDLED WITH
+   1.11.2

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Max Lielje & David Pfahler
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,125 @@
+# `chartd-rb` – Encode data for chartd.co
+
+[![Build Status](https://travis-ci.org/commissure/chartd-rb.svg?branch=master)](https://travis-ci.org/commissure/chartd-rb)
+
+:chart_with_upwards_trend: `chartd-rb` is a Ruby gem for [chartd.co],
+a service from [@stathat], that allows you to creat a chart by encoding
+a dataset into an URL, like so:
+
+  [chartd.co]: https://chartd.co
+  [@stathat]: https://github.com/stathat
+
+```
+https://chartd.co/a.png?w=580&h=180&d0=SRWfaZHLHEDABKKTUYgpqqvws0138eZfaYtwxxsxyst&ymin=94.48&ymax=103.3
+```
+
+The URL can then be used with a simple `<img>` tag and the resulting
+chart looks like this:
+
+<img src="https://chartd.co/a.png?w=580&h=180&d0=SRWfaZHLHEDABKKTUYgpqqvws0138eZfaYtwxxsxyst&ymin=94.48&ymax=103.3">
+
+
+## Usage
+
+```ruby
+# grab some data
+data = [1, 2, 3]
+
+# and create a chart
+chart = Chartd::Chart.new(data)
+
+chart.url # => https://chartd.co/a.png?d0=Ae9…
+```
+
+### Y-Axis Minimum & Maximum
+
+By default `chartd` uses the minimum and maximum values from your
+dataset. They can be set explicitly like this:
+
+```ruby
+Chartd::Chart.new(data, min: 0, max: 100)
+```
+
+### Multiple Datasets
+
+`data` can also be a multidimensional array, which will result in the
+chart having multiple lines. The maximum of datasets to chart is 5.
+
+Example:
+
+```ruby
+# grab some more data
+data = [
+  [1, 3, 2],
+  [5, 3, 4]
+]
+
+# and create a chart
+chart = Chartd::Chart.new(data)
+
+chart.url # => https://chartd.co/a.png?d0=AeP&d1=9et…
+```
+
+### Width & Height
+
+The default dimensions of a chart are `580px x 180px`. You can change
+them using the `options` parameter:
+
+```ruby
+Chartd::Chart.new(data, options: { w: 2000, h: 1000 })
+```
+
+**:warning: Important:** chartd doubles the dimensions of the chart so
+that the resulting image is `@2x`, meaning it looks great on retina
+(high res) screens.
+
+### Disabling Y-Axis Labels
+
+The y-axis are both labeled by default. Set `ylabel` to `false` when
+creating a chart to turn that off:
+
+```ruby
+Chartd::Chart.new(data, ylabels: false)
+```
+
+### Image Format
+
+While chartd supports both `.svg` and `.png`, `chartd-rb` currently
+only supports `.png`. [Issue #2][#2] explains why.
+
+  [#2]: https://github.com/commissure/chartd-rb/issues/2
+
+### Options
+
+The `options` hash is written directly to the final URL, meaning
+that [all parameters documented on chartd.co][chartd] can be used.
+Example:
+
+  [chartd]: https://chartd.co/
+
+```ruby
+Chartd::Chart.new(data, options: {
+  t: 'My Awesome Chart',
+  step: 1,
+  hl: 1,
+})
+```
+
+I would be happy to accept a PR that integrates some of them (for
+example the coloring) a little bit more nicely.
+
+
+## Contributing
+
+1. Fork the repository
+2. Create a feature branch: `git checkout -b your-feature`
+3. Add your changes
+4. Write tests and check coverage report in `coverage/index.html`
+5. Push changes: `git push -u origin your-feature`
+6. Submit a pull request
+
+
+## License
+
+This project is licensed under the **MIT license**. See the `LICENSE`
+file for details.

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc 'Run tests'
+task default: :test

data/chartd.gemspec

@@ -0,0 +1,17 @@
+Gem::Specification.new do |s|
+  s.name        = 'chartd'
+  s.version     = '1.0.0'
+  s.summary     = 'Encode values for chartd.co'
+  s.description = 'Chartd helps you encode values for use with chartd.co.'
+  s.authors     = ['Max Lielje', 'David Pfahler']
+  s.email       = 'max@pagespeed.io'
+  s.files       = `git ls-files`.split("\n")
+  s.test_files  = `git ls-files -- test/*`.split("\n")
+
+  s.homepage    = 'https://github.com/commissure/chartd-rb'
+  s.license     = 'MIT'
+
+  s.add_development_dependency 'rake', '~> 11.2'
+  s.add_development_dependency 'test-unit', '~> 3.2'
+  s.add_development_dependency 'simplecov', '~> 0.12'
+end

data/lib/chartd.rb

@@ -0,0 +1,10 @@
+require 'chartd/chart'
+require 'chartd/encoder'
+
+class Chartd
+  # helper method for directly encoding data for when the user wants to
+  # generate the chart URL herself.
+  def self.encode(*args)
+    Encoder.encode(*args)
+  end
+end

data/lib/chartd/chart.rb

@@ -0,0 +1,66 @@
+require 'chartd/encoder'
+require 'uri'
+
+class Chartd
+  BASE_URL = URI.parse('https://chartd.co/a.png')
+
+  class Chart
+    ERR_BAD_DATASET = 'Dataset has to be an array of Fixnums and/or Floats.'.freeze
+    ERR_TOO_MANY_DATASETS = 'Too many datasets supplied, the maximum is 5.'.freeze
+
+    attr_reader :dataset
+
+    # allow min and max to be changed after instantiating a Chart
+    attr_accessor :min, :max
+
+    def initialize(dataset = [], min: nil, max: nil, ylabels: true, options: {})
+      raise ERR_BAD_DATASET unless dataset.is_a?(Array)
+      raise ERR_TOO_MANY_DATASETS if dataset.count > 5
+
+      # Check if dataset is multidimensional and if so, use it as is.
+      # Otherwise make it multidimensional.
+      if dataset[0].is_a?(Array)
+        @dataset = dataset
+      else
+        @dataset = [dataset]
+      end
+
+      # calculate min and max across the entire dataset but only if they are
+      # not set explicitly.
+      @min = min || dataset.flatten.min
+      @max = max || dataset.flatten.max
+
+      @ylabels = ylabels
+
+      @options = default_options.merge(options)
+    end
+
+    def url
+      u = BASE_URL.dup
+
+      # encode each piece of data and append it to URL as params
+      encoded_data = @dataset.each_with_index.map do |d, i|
+        ["d#{i}", Encoder.encode(d, min: @min, max: @max)]
+      end
+
+      # set labels for y axis when they’re enabled (which they are by default)
+      if @ylabels
+        @options[:ymin] ||= @min
+        @options[:ymax] ||= @max
+      end
+
+      u.query = URI.encode_www_form(
+        @options.merge(encoded_data.to_h)
+      )
+      u.to_s.force_encoding('utf-8')
+    end
+
+    private
+
+    # Default options for a chart URL, can be overridden when instantiating a
+    # Chart using the options argument.
+    def default_options
+      { w: 580, h: 180 }
+    end
+  end
+end

data/lib/chartd/encoder.rb

@@ -0,0 +1,44 @@
+class Chartd
+  module Encoder
+    B62 = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789'.freeze
+
+    # encode encodes a dataset to a format that chartd.co understands.
+    # It optionally takes min and max values that change the resulting chart.
+    def self.encode(dataset = [], min: nil, max: nil)
+      return '' if dataset.empty?
+
+      # either use custom min & max values or take them from the dataset
+      min ||= dataset.min
+      max ||= dataset.max
+
+      range = dim(max, min)
+
+      # if the range of the data is
+      return B62[0] * dataset.count if range == 0
+
+      enclen = B62.length - 1
+      encoded = dataset.map do |v|
+        index = (enclen * (v - min) / range).to_i
+
+        # TODO: see if else case is even possible
+        if index >= 0 && index < B62.length
+          B62[index]
+        else
+          B62[0]
+        end
+      end
+
+      encoded.join
+    end
+
+    # dim returns the maximum of x-y or 0.
+    # It is used to calculate the range of the dataset.
+    def self.dim(x, y)
+      # TODO: maybe raise an exception if max < min (x < y)
+      return 0 if x < y
+
+      x - y
+    end
+    private_class_method :dim
+  end
+end

data/test/test_chartd.rb

@@ -0,0 +1,108 @@
+require_relative 'test_helper'
+
+require 'test/unit'
+require 'chartd'
+
+class ChartdTest < Test::Unit::TestCase
+  def test_chart
+    expected = 'https://chartd.co/a.png?w=580&h=180&ymin=1.2&ymax=3.1&d0=Am9'
+    chart = Chartd::Chart.new([1.2, 2.4, 3.1])
+
+    assert_equal expected, chart.url
+  end
+
+  def test_chart_multiline
+    testdata = {
+      'https://chartd.co/a.png?w=580&h=180&ymin=0.17&ymax=3.1&d0=Vu9&d1=QAI' => [
+        [1.2, 2.4, 3.1],
+        [0.944, 0.170, 0.601],
+      ],
+      'https://chartd.co/a.png?w=580&h=180&ymin=1&ymax=5&d0=AeP&d1=9et' => [
+        [1, 3, 2],
+        [5, 3, 4],
+      ],
+    }
+
+    testdata.each do |expected, dataset|
+      chart = Chartd::Chart.new(dataset)
+      assert_equal expected, chart.url
+    end
+  end
+
+  def test_chart_multiline_custom_min_max
+    testdata = {
+      'https://chartd.co/a.png?w=580&h=180&ymin=0&ymax=4&d0=Skv&d1=OCJ' => {
+        dataset: [
+          [1.2, 2.4, 3.1],
+          [0.944, 0.170, 0.601],
+        ],
+        min: 0,
+        max: 4,
+      },
+      'https://chartd.co/a.png?w=580&h=180&ymin=0&ymax=6&d0=KeU&d1=yeo' => {
+        dataset: [
+          [1, 3, 2],
+          [5, 3, 4],
+        ],
+        min: 0,
+        max: 6,
+      },
+    }
+
+    testdata.each do |expected, data|
+      chart = Chartd::Chart.new(
+        data[:dataset],
+        min: data[:min],
+        max: data[:max]
+      )
+      assert_equal expected, chart.url
+    end
+  end
+
+  def test_normalize_datasets
+    assert_equal [[1, 2, 3]], Chartd::Chart.new([1, 2, 3]).dataset
+    assert_equal [[2, 3], [3, 4]], Chartd::Chart.new([[2, 3], [3, 4]]).dataset
+  end
+
+  def test_min_max_accessors
+    dataset = [1, 2, 3]
+
+    regular = Chartd::Chart.new(dataset, min: 0, max: 5)
+
+    with_accessors = Chartd::Chart.new(dataset)
+    with_accessors.min = 0
+    with_accessors.max = 5
+
+    assert_equal regular.url, with_accessors.url
+  end
+
+  def test_raise_on_bad_dataset
+    assert_raise do
+      Chartd::Chart.new('foo bar')
+    end
+
+    assert_raise do
+      # a maximum of 5 datasets is supported by chartd
+      Chartd::Chart.new([[1], [1], [1], [1], [1], [1]])
+    end
+  end
+
+  def test_disable_y_labels
+    url = Chartd::Chart.new([1, 2, 3], ylabels: false).url
+    assert_no_match %r{ymin=}, url
+    assert_no_match %r{ymax=}, url
+  end
+
+  def test_options
+    options = {
+      t: 'Awesome Chart',
+      step: 1,
+      foo: 'bar',
+    }
+
+    url = Chartd::Chart.new([1, 2, 3], options: options).url
+    assert_match %r{t=Awesome\+Chart}, url
+    assert_match %r{step=1}, url
+    assert_match %r{foo=bar}, url
+  end
+end

data/test/test_encode.rb

@@ -0,0 +1,37 @@
+require_relative 'test_helper'
+
+require 'test/unit'
+require 'chartd'
+
+class Chartd::EncodeTest < Test::Unit::TestCase
+  def test_encode
+    testcases = [
+      [[1.2, 2.4, 3.1], 'Am9'],
+      [[40, 50, 33.2], 'Y8A'],
+      [[0, 9, 9], 'A99'],
+      [[0.944, 0.170, 0.201, 0.839, 0.284, 0.485, 0.154, 0.431, 0.119, 0.679], '9DG1MbCXAp'],
+      [[0, -2, 9], 'LA9'],
+      [[0], 'A'],
+      [[], ''],
+    ]
+
+    testcases.each do |d, expected|
+      assert_equal expected, Chartd::Encoder.encode(d)
+    end
+  end
+
+  def test_encode_custom_min_max
+    testcases = {
+      'Ueo' => [[20, 30, 40], 0, 60],
+      'Ae9' => [[20, 30, 40], 20, 40],
+    }
+
+    testcases.each do |expected, data|
+      assert_equal expected, Chartd::Encoder.encode(data[0], min: data[1], max: data[2])
+    end
+  end
+
+  def test_encode_helper
+    assert_equal Chartd::Encoder.encode([1, 2, 3]), Chartd.encode([1, 2, 3])
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,2 @@
+require 'simplecov'
+SimpleCov.start

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: chartd
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Max Lielje
+- David Pfahler
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-07-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.2'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+description: Chartd helps you encode values for use with chartd.co.
+email: max@pagespeed.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- chartd.gemspec
+- lib/chartd.rb
+- lib/chartd/chart.rb
+- lib/chartd/encoder.rb
+- test/test_chartd.rb
+- test/test_encode.rb
+- test/test_helper.rb
+homepage: https://github.com/commissure/chartd-rb
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Encode values for chartd.co
+test_files:
+- test/test_chartd.rb
+- test/test_encode.rb
+- test/test_helper.rb