squid 0.0.0 → 1.0.0.beta1

data/lib/squid/point.rb

@@ -0,0 +1,40 @@
+require 'squid/format'
+
+module Squid
+  class Point
+    extend Format
+
+    def self.for(series, minmax:, height:, labels:, stack:, format:)
+      @min = Hash.new 0
+      @max = Hash.new 0
+      min, max = minmax
+      offset = -> (value) { value * height.to_f / (max-min) }
+      series.map do |values|
+        values.map.with_index do |value, i|
+          h = y_for value, index: i, stack: false, &offset if value
+          y = y_for value, index: i, stack: stack, &offset if value
+          y = y - offset.call([min, 0].min) if value
+          label = format_for(value, format) if labels
+          new y: y, height: h, index: i, label: label, negative: value.to_f < 0
+        end
+      end
+    end
+
+    attr_reader :y, :height, :index, :label, :negative
+
+    def initialize(y:, height:, index:, label:, negative:)
+      @y, @height, @index, @label, @negative = y, height, index, label, negative
+    end
+
+  private
+
+    def self.y_for(value, index:, stack:, &block)
+      if stack
+        hash = (value > 0) ? @max : @min
+        yield(hash[index] += value)
+      else
+        yield(value)
+      end
+    end
+  end
+end

data/lib/squid/settings.rb

@@ -0,0 +1,15 @@
+require 'squid/config'
+
+module Squid
+  # @private
+  module Settings
+    def has_settings(*keys)
+      keys.each do |key|
+        define_method key do
+          @settings.fetch key, Squid.configuration.public_send(key)
+        end
+        private key
+      end
+    end
+  end
+end

data/lib/squid/version.rb

@@ -1,3 +1,3 @@
 module Squid
-  VERSION = '0.0.0'
+  VERSION = '1.0.0.beta1'
 end

data/lib/squid.rb

@@ -1,5 +1,37 @@
-# Provides a method to listen and respond to messages in a Campfire room.
+require 'prawn'
+require 'squid/graph'
+
 module Squid
-  def self.run(options = {})
+  # Provides the `chart` method to use in Prawn::Document
+  # @see http://prawnpdf.org/api-docs/2.0/Prawn/Document.html
+  module Interface
+    # Plots a graph the current document.
+    #
+    # @param [Hash<#to_s, [Hash<#to_s, Numeric>]>] data the series to plot in 
+    #   the graph. Each key is the name of the series, and each value contains
+    #   the values for the series. Values are also a hash, where each key is
+    #   a category, and each value the numerical value for that category.
+    # @param [Hash] settings the option to customize the graph.
+    # @option settings [Boolean] :baseline (true) whether to plot the baseline.
+    # @option settings [Boolean] :border (false) whether to plot the border.
+    # @option settings [Boolean] :chart (true) whether to plot the chart.
+    # @option settings [Array<String>] :colors (true) the color of each series.
+    # @option settings [Integer] :every (1) how often to plot the categories.
+    # @option settings [Symbol] :format (:integer) the format of axis values.
+    # @option settings [Numeric] :height (250) the full height of the graph.
+    # @option settings [Boolean] :labels (false) whether to plot value labels.
+    # @option settings [<Boolean, Hash>] :legend (true) whether to plot the
+    #   legend. If a Hash is provided, the `:offset` option can be set to
+    #   specify the offset between the legend and the right margin.
+    # @option settings [Numeric] :line_width (3) the line width for line graphs.
+    # @option settings [Numeric] :steps (4) the number of gridlines.
+    # @option settings [Boolean] :ticks (true) whether to plot the ticks.
+    # @option settings [Symbol] :type (:column) the type of graph.
+    def chart(data =  {}, settings = {})
+      Graph.new(self, data, settings).draw
+    end
   end
-end
+end
+
+# Extends Prawn::Document to include the `chart` methods
+Prawn::Document.extensions << Squid::Interface

data/squid.gemspec

@@ -1,23 +1,31 @@
-# coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'squid/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "squid"
+  spec.name          = 'squid'
   spec.version       = Squid::VERSION
-  spec.authors       = ["claudiob"]
-  spec.email         = ["claudiob@gmail.com"]
-  spec.description   = %q{Prawn evolved}
-  spec.summary       = %q{Prawn evolved}
-  spec.homepage      = ""
-  spec.license       = "MIT"
+  spec.authors       = ['claudiob']
+  spec.email         = ['claudiob@gmail.com']
 
-  spec.files         = `git ls-files`.split($/)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.summary       = %q{Generates graphs in PDF files.}
+  spec.description   = %q{Squid expands Prawn providing method to easily draw graphs in PDF files.}
+  spec.homepage      = 'https://github.com/fullscreen/squid'
+  spec.license       = 'MIT'
 
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
+  spec.required_ruby_version = '>= 2.1.0' # 2.0 does not have Numeric#step(by:, to:)
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency             'prawn', '~> 2.0'
+  spec.add_dependency             'activesupport', '~> 4.0' # 3.2 does not have ActiveSupport::NumberHelper#number_to_rounded
+  spec.add_development_dependency 'pdf-inspector', '~> 1.2'
+  spec.add_development_dependency 'prawn-manual_builder', '~> 0.2.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.3'
+  spec.add_development_dependency 'coveralls', '~> 0.8.2'
+  spec.add_development_dependency 'pry-nav', '~> 0.2.4'
 end

metadata

@@ -1,62 +1,216 @@
 --- !ruby/object:Gem::Specification
 name: squid
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 1.0.0.beta1
 platform: ruby
 authors:
 - claudiob
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2015-06-03 00:00:00.000000000 Z
+date: 2015-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: prawn
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: pdf-inspector
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: prawn-manual_builder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: Prawn evolved
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+description: Squid expands Prawn providing method to easily draw graphs in PDF files.
 email:
 - claudiob@gmail.com
-executables:
-- squid
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
-- HISTORY.md
-- LICENSE.txt
+- MIT-LICENSE
 - README.md
 - Rakefile
-- bin/squid
+- bin/console
+- bin/setup
+- examples/manual.rb
+- examples/readme.rb
+- examples/readme/01-basic.rb
+- examples/readme/02-type-point.rb
+- examples/readme/03-type-line.rb
+- examples/readme/04-color.rb
+- examples/readme/05-gridlines.rb
+- examples/readme/06-ticks.rb
+- examples/readme/07-baseline.rb
+- examples/readme/08-every.rb
+- examples/readme/09-legend.rb
+- examples/readme/10-legend-offset.rb
+- examples/readme/11-format.rb
+- examples/readme/12-labels.rb
+- examples/readme/13-border.rb
+- examples/readme/14-height.rb
+- examples/readme/15-multiple-columns.rb
+- examples/readme/16-multiple-stacks.rb
+- examples/readme/17-two-axis.rb
+- examples/readme/readme.rb
+- examples/screenshots/readme_00.png
+- examples/screenshots/readme_01.png
+- examples/screenshots/readme_02.png
+- examples/screenshots/readme_03.png
+- examples/screenshots/readme_04.png
+- examples/screenshots/readme_05.png
+- examples/screenshots/readme_06.png
+- examples/screenshots/readme_07.png
+- examples/screenshots/readme_08.png
+- examples/screenshots/readme_09.png
+- examples/screenshots/readme_10.png
+- examples/screenshots/readme_11.png
+- examples/screenshots/readme_12.png
+- examples/screenshots/readme_13.png
+- examples/screenshots/readme_14.png
+- examples/screenshots/readme_15.png
+- examples/screenshots/readme_16.png
+- examples/screenshots/readme_17.png
+- examples/squid/baseline.rb
+- examples/squid/basic.rb
+- examples/squid/border.rb
+- examples/squid/columns.rb
+- examples/squid/every.rb
+- examples/squid/format.rb
+- examples/squid/gridlines.rb
+- examples/squid/height.rb
+- examples/squid/labels.rb
+- examples/squid/legend.rb
+- examples/squid/legend_offset.rb
+- examples/squid/line.rb
+- examples/squid/line_width.rb
+- examples/squid/lines.rb
+- examples/squid/point.rb
+- examples/squid/points.rb
+- examples/squid/squid.rb
+- examples/squid/stacks.rb
+- examples/squid/ticks.rb
+- examples/squid/two_axis.rb
 - lib/squid.rb
+- lib/squid/axis.rb
+- lib/squid/axis_label.rb
+- lib/squid/config.rb
+- lib/squid/configuration.rb
+- lib/squid/format.rb
+- lib/squid/graph.rb
+- lib/squid/gridline.rb
+- lib/squid/plotter.rb
+- lib/squid/point.rb
+- lib/squid/settings.rb
 - lib/squid/version.rb
 - squid.gemspec
-homepage: ''
+homepage: https://github.com/fullscreen/squid
 licenses:
 - MIT
 metadata: {}
@@ -68,17 +222,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
-summary: Prawn evolved
+summary: Generates graphs in PDF files.
 test_files: []
-has_rdoc: 

data/HISTORY.md

@@ -1 +0,0 @@
-v0.0.0  - 2015/06/03 First version

data/LICENSE.txt

@@ -1,22 +0,0 @@
-Copyright (c) 2013 claudiob
-
-MIT License
-
-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/bin/squid

@@ -1,8 +0,0 @@
-#!/usr/bin/env ruby
-
-begin
-  require 'squid'
-rescue LoadError
-  require 'rubygems'
-  require 'squid'
-end