prawn-graph 0.0.4 → 0.9.0

data/.travis.yml

@@ -0,0 +1,17 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.0-p0
+  - 2.1.8
+  - 2.2.0-p0
+  - 2.2.4
+  - 2.3.0
+  - jruby-9.0.5.0
+  - rbx-3.19
+matrix:
+  allow_failures:
+    - rvm: rbx-3.19
+before_install: gem install bundler -v 1.11.2
+addons:
+    code_climate:
+        repo_token: 9646aae52d1d1670d545c46bd94f5d86b92d516c5e3cb9890fcef62acc3a34b6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at ryan@ryanstenhouse.eu. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/CONTRIBUTORS.md

@@ -0,0 +1,6 @@
+Past and present direct and indirect contributors to prawn-graph
+----------------------------------------------------------------
+
+  *  Ryan Stenhouse <https://github.com/hhry>
+  *  Roger Nesbitt <https://github.com/mogest>
+  *  S. Hessam M. Mehr <https://github.com/hessammehr>

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in prawn-graph.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Ryan Stenhouse
+
+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,142 @@
+# Prawn::Graph - Easy Graphing for Prawn
+
+[![Gem Version](https://badge.fury.io/rb/prawn-graph.svg)](https://badge.fury.io/rb/prawn-graph)
+[![License](http://img.shields.io/:license-mit-blue.svg)](http://sujrd.mit-license.org)
+[![Code Climate](https://codeclimate.com/github/HHRy/prawn-graph/badges/gpa.svg)](https://codeclimate.com/github/HHRy/prawn-graph)
+[![Test Coverage](https://codeclimate.com/github/HHRy/prawn-graph/badges/coverage.svg)](https://codeclimate.com/github/HHRy/prawn-graph/coverage)
+[![Build Status](https://travis-ci.org/HHRy/prawn-graph.svg?branch=master)](https://travis-ci.org/HHRy/prawn-graph)
+[![security](https://hakiri.io/github/HHRy/prawn-graph/master.svg)](https://hakiri.io/github/HHRy/prawn-graph/master)
+![Maintained: yes](https://img.shields.io/badge/maintained-yes-brightgreen.png)
+
+An extension for the [prawn pdf library][5] which adds the ability to draw graphs (or charts if
+you perfer) in PDF documents.
+
+Because Prawn::Graph only uses the native PDF drawing functions exposed by Prawn, it removes the need to 
+depend on projects like Gruff to generate heavy PNG / JPG images of such graphs and charts and then include
+those large blobs in your documents. The results may not be as pretty (yet), but the file-size differences 
+are dramatic.
+
+By default, graphs are drawn in monochrome, as that's likely how they will be printed. 
+
+This is free and open source software released under ther terms of the [MIT Licence](http://opensource.org/licenses/MIT).
+
+Its copyright is held by Ryan Stenhouse and the [other contributors][8] and it was first released in 
+2010.
+
+## Compatibility
+
+This gem is built assuming a Ruby version of 2.0 or higher. Older Ruby versions may work but are not 
+officially supported. We aim for compatibilty with 1.x and 2.x series of prawn. Any incomaptibilities
+with prawn versions should be treated as bugs and added to the [issue tracker][2]. 
+
+We build automatically using Travis CI. Our [.travis.yml][9] file targets the same Ruby versions as
+[prawn itself][5] does.
+
+
+### Legacy support and deprecation notices.
+
+To provide backwards-compatibility (of sorts), `prawn-graph` provides `bar_graph` (aliased as `bar_chart`)
+and `line_graph` (aliased as `line_chart`) methods as part of its interface which function the same as their
+equivalents in version `0.0.4`. These methods are, however, deprecated and **will** be removed when version
+`1.0.0` is released. Using these methods will result in a `warn` level message from Ruby.
+
+These legacy methods will still be buggy as they are using the same rendering methods as before. Where possible
+you should use the new `graph` (aliased as `chart`) interface. Unless serious problems are uncovered, bugs
+reported with legacy rendering **will not be considered**.
+
+Unlike previous versions of `prawn-graph`, this version does not at this time include a theme api or the 
+ability to change the colors used to render the graph. 
+
+## Installation
+
+To use prawn-graph, you can add the following to your `Gemfile`:
+
+```Gemfile
+ gem 'prawn-graph', '0.9.0'
+```
+
+Alternatively, you can use Rubygems directly: `gem install prawn-graph`.
+ 
+## Acknowledgements
+
+With thanks to [株式会社アルム][3] ([Allm Inc][4]) for allowing Ryan Stenhouse the time to rebuild this version of
+prawn-graph. This updated version of prawn-graph was inspired and guided by [prawn-svg][1] by [Roger Nesbitt][6]. 
+
+Prawn Graph was originally sponsored by and built for use at [Purchasing Card Consultancy Ltd][7] while
+Ryan Stenhouse was employed there.
+
+## Supported graph / chart types
+
+This version of Prawn::Graph supports the following graph / chart types:
+
+  *  Bar Charts 
+  *  Line Charts
+
+Is your favourite chart type not supported yet? [Please request it][2], or if you are feeling particularly
+adventurous - please add it!
+
+## Using prawn-graph
+
+```ruby
+  require 'prawn-graph'
+
+  series = []
+  series << Prawn::Graph::Series.new([1,2,3,4,5], title: "Some numbers", type: :bar)
+
+  Prawn::Document.generate('test.pdf') do
+    graph series
+  end
+```
+
+When called with just a set of data, prawn-graph will do its best to make the graph fit in the 
+available space. For a little more control over how the graphs are rendered in the document
+you can pass the following options:
+
+Option      | Data type | Description
+----------- | --------- | -----------
+:at         | [integer, integer] | Specify the location on the page you want the graph to appear.
+:width      | integer   | Desired width of the graph.  Defaults to horizontal space available.
+:height     | integer   | Desired height of the graph.  Defaults to vertical space available.
+
+### Advanced example
+
+```ruby
+  require 'prawn-graph'
+
+  series = []
+  series << Prawn::Graph::Series.new([5,4,3,2,1,1,2,8,7,5,4,9,2], title: "Some more numbers", type: :bar)
+  series << Prawn::Graph::Series.new([5,4,3,2,1,1,2,8,7,5,4,9,2].reverse, title: "Some more numbers", type: :bar)
+  series << Prawn::Graph::Series.new([1,2,3,4,5,9,6,4,5,6,3,2,9], title: "Some numbers", type: :bar)
+  series << Prawn::Graph::Series.new([1,2,3,4,5,9,6,4,5,6,3,2,9].shuffle, title: "Some numbers", type: :line)
+
+  Prawn::Document.generate('test.pdf') do
+    graph series, width: 500, height: 200, title: "A very long title will porbably be clipped", at: [10,700]
+  end
+``` 
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can
+also  run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the 
+version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, 
+push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome [on GitHub][2]. This project is intended to be a 
+safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) 
+code of conduct.
+
+
+
+[1]: https://github.com/mogest/prawn-svg/
+[2]: https://github.com/hhry/prawn-graph/issues/
+[3]: http://www.allm.net/
+[4]: http://www.allm.net/en/
+[5]: http://github.com/prawnpdf/prawn/
+[6]: https://github.com/mogest/
+[7]: http://www.pccl.co.uk/
+[8]: https://github.com/HHRy/prawn-graph/blob/master/CONTRIBUTORS.md
+[9]: https://github.com/HHRy/prawn-graph/blob/master/.travis.yml

data/Rakefile

@@ -1,48 +1,12 @@
-require 'rubygems'
-require 'rake'
-require "rake/gempackagetask" 
-require "rake/rdoctask"
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require 'yard'
 
-PRAWN_GRAPH_VERSION = '0.0.4'
 
-spec = Gem::Specification.new do |spec|
-  spec.name = "prawn-graph"
-  spec.version = PRAWN_GRAPH_VERSION
-  spec.platform = Gem::Platform::RUBY
-  spec.summary = "An extension to Prawn that provides the ability to draw basic graphs and charts natively in your PDFs."
-  spec.files = Dir.glob("{examples,lib,spec,vendor,data}/**/**/*") +
-                      ["Rakefile"]
-  spec.require_path = "lib"
-  
-  spec.test_files = Dir[ "test/*_test.rb" ]
-  spec.has_rdoc = true
-  spec.extra_rdoc_files = %w{README.markdown}
-  spec.rdoc_options << '--title' << 'Prawn Documentation' <<
-                       '--main' << 'README' << '-q'
-  spec.author = "Ryan Stenhouse"
-  spec.email = " ryan@ryanstenhouse.eu"
-  spec.rubyforge_project = "prawn"
-  spec.add_dependency 'prawn'
-  spec.homepage = "http://ryanstenhouse.eu"
-  spec.description = <<END_DESC
-  An extension to Prawn that provides the ability to draw basic graphs and charts natively in your PDFs.
-END_DESC
+YARD::Rake::YardocTask.new do |t|
+  t.files   = ['lib/**/*.rb', '-', '*.md']
 end
 
-desc "genrates documentation"
-Rake::RDocTask.new do |rdoc|
-  rdoc.rdoc_files.include( "README.markdown",
-                           "COPYING",
-                           "LICENSE", 
-                           "HACKING", "lib/" )
-  rdoc.main     = "README.markdown"
-  rdoc.rdoc_dir = "doc/html"
-  rdoc.title    = "Prawn Documentation"
-end     
+RSpec::Core::RakeTask.new(:spec)
 
- 
-Rake::GemPackageTask.new(spec) do |pkg|
-  pkg.need_zip = true
-  pkg.need_tar = true
-end
- 
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "prawn-graph"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/prawn-graph.rb

@@ -0,0 +1,16 @@
+require "ostruct"
+require "bigdecimal"
+require "prawn"
+require "prawn/graph/version"
+require "prawn/graph/calculations"
+
+require "prawn/graph/chart_components"
+
+require "prawn/graph/theme"
+require "prawn/graph/series"
+require "prawn/graph/charts"
+
+require "prawn/graph/extension"
+
+
+Prawn::Document.extensions << Prawn::Graph::Extension

data/lib/prawn/graph/calculations.rb

@@ -0,0 +1 @@
+require_relative "calculations/layout_calculator"

data/lib/prawn/graph/calculations/layout_calculator.rb

@@ -0,0 +1,108 @@
+module Prawn
+  module Graph
+    module Calculations
+
+      class LayoutCalculator
+        attr_reader :bounds
+        attr_reader :series_key_area, :title_area, :graph_area, :canvas_width, :canvas_height
+
+        class Dimensions < OpenStruct
+          def renderable?
+            width > 0 && height > 0
+          end
+
+          def point
+            [x, y]
+          end
+        end
+
+        def initialize(bounds, attributes = nil, theme = Prawn::Graph::Theme::Default)
+          @bounds = bounds
+          @graph_area       = Dimensions.new({ width: 0, height: 0, x: 0, y: 0 })
+          @title_area       = Dimensions.new({ width: 0, height: 0, x: 0, y: 0 })
+          @series_key_area  = Dimensions.new({ width: 0, height: 0, x: 0, y: 0 })
+          @theme            = theme
+          set_from_attributes(attributes) if attributes
+        end
+
+        def calculate
+          calculate_width_and_height_of_canvas
+          calculate_key_area
+          calculate_title_area
+          calculate_graph_area
+          
+          self
+        end
+
+        def hpadding
+          ((BigDecimal(canvas_width) / 100) * 2).round
+        end
+
+        def vpadding
+          ((BigDecimal(canvas_height) / 100) * 2).round
+        end
+
+        def invalid?
+          canvas_width > bounds[0] || canvas_height > bounds[1]
+        end
+
+        private
+
+        def set_from_attributes(attributes)
+          @canvas_width = BigDecimal(attributes[:width], 10) rescue 0
+          @canvas_height = BigDecimal(attributes[:height], 10) rescue 0
+          @num_series = attributes[:series_count] || 1
+          @title = attributes[:title]
+        end
+
+        def calculate_width_and_height_of_canvas
+          if @canvas_width.zero? && @canvas_height.zero?
+            @canvas_width   = BigDecimal(bounds[0], 10) 
+            @canvas_height  = BigDecimal(bounds[1], 10) 
+          elsif !@canvas_width.zero? && @canvas_height.zero?
+            @canvas_height  = (@canvas_width / bounds_aspect_ratio).round
+          elsif !@canvas_height.zero? && @canvas_width.zero?
+            @canvas_width  = (@canvas_height * bounds_aspect_ratio).round
+          end
+        end
+
+        def bounds_aspect_ratio
+          BigDecimal(bounds[0], 10) / BigDecimal(bounds[1], 10)
+        end
+
+        def calculate_title_area
+          unless @title.nil?
+            @title_area[:width] = (canvas_width - @series_key_area[:width] - (2*hpadding))
+            @title_area[:x] = hpadding
+            @title_area[:height] = @theme.font_sizes.main_title + vpadding
+            @title_area[:y] = canvas_height + vpadding 
+          end
+        end
+
+        def calculate_key_area
+          if @num_series > 1
+            @series_key_area[:width] = ( (canvas_width / 100) * 25 ).round
+            @series_key_area[:x] = (canvas_width - @series_key_area[:width] - hpadding)
+            @series_key_area[:y] = canvas_height + vpadding
+            @series_key_area[:height] = (canvas_height - vpadding)
+          end 
+        end
+
+        def calculate_graph_area
+          @graph_area[:width] = (canvas_width - @series_key_area[:width] - (2*hpadding))
+          @graph_area[:x] = hpadding
+
+          if !@title_area.renderable?
+            @graph_area[:y] = canvas_height + vpadding
+            @graph_area[:height] = (canvas_height - vpadding)
+          else
+            @graph_area[:y] =  (@title_area[:y] - @title_area[:height])
+            @graph_area[:height] = (canvas_height - vpadding - @title_area[:height])
+          end
+        end
+
+      end
+
+    end
+  end
+end