squid 1.0.0.beta4 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a00480f821e936a668268b22625ca7c831ff2167
-  data.tar.gz: daca6d6efa833ea070dc26b8b5ea539c881c77c5
+  metadata.gz: eb7adb69f44a7ea7f14d6fd37978e93c0fdeb880
+  data.tar.gz: bc57c30c7eff1cfa811dd81b965e23fb5a058bfc
 SHA512:
-  metadata.gz: 697ce4da5a66d023cbbec823c746abc75729f26a775a31cd7e5190b9c7f1b3b6128f8aca4d015f332ca704712bebd5e3751ec743571dd2e18774764123e02963
-  data.tar.gz: 8ab412a9b15935caa0775077493922ab2d48dc8268b00db5df7e647aef8efd321ab2a7a769de4e21e07510ff0f46d520969ad5abf98e74daeacd1bc3acdde781
+  metadata.gz: dc98af60cfceca88f7de615fa00f46dc792bd4b2c1df6ac2cce16392b3ceb1df5c6a912300abdec004e7d963945f154412eec81e8ceb3606ea832dfe7e322886
+  data.tar.gz: 0937cd2ca8cdbfd064e955b9a50cb1178823f97174088f99a7bf6b2519094fc3901e70b2e8208c528d0651a25b74e7ae0734b7232ec845ef8493eeeb6b0c739c

data/.gitignore

@@ -9,3 +9,5 @@
 /tmp/
 manual.pdf
 readme.pdf
+/_site
+screenshots.pdf

data/CHANGELOG.md

@@ -6,6 +6,6 @@ For more information about changelogs, check
 [Keep a Changelog](http://keepachangelog.com) and
 [Vandamme](http://tech-angels.github.io/vandamme).
 
-## 1.0.0 - unreleased
+## 1.0.0 - 2015.08.31
 
 * [FEATURE] Add `chart` method to Prawn::Document to draw graphs.

data/README.md

@@ -26,107 +26,16 @@ data = {views: {2013 => 182, 2014 => 46, 2015 => 134}}
 chart data
 ```
 
-![01-basic](https://raw.githubusercontent.com/fullscreen/squid/master/examples/screenshots/readme_01.png "chart(data)")
+![01-basic](https://raw.githubusercontent.com/fullscreen/squid/master/examples/readme.png "chart(data)")
 
+A comprehensive guide to Squid options
+======================================
 
-Graph options
--------------
+All the settings available for the `chart` method are detailed on the [Squid homepage](http://fullscreen.github.io/squid):
 
-By providing `options` to the `chart` method, you can customize the format of the graph.
+[![Squid homepage](https://cloud.githubusercontent.com/assets/7408595/9561009/3a333b1c-4de8-11e5-9eeb-0c45649e41b7.png)](http://fullscreen.github.io/squid)
 
-Multiple options can be combined. Here is a comprehensive list.
-
-##### `:type` sets the type of graph. Can be `:column` (default), `:point`, or `:line`.
-
-![02-type-point](https://raw.githubusercontent.com/fullscreen/squid/master/examples/screenshots/readme_02.png "chart(data, type: :point)")
-
-##### `:line_width` changes the line width (default: `3`, only applies to line graphs).
-
-![03-type-line](https://raw.githubusercontent.com/fullscreen/squid/master/examples/screenshots/readme_03.png "chart(data, type: :line, line_width: 10)")
-
-##### `:color` changes the color of the chart (default: `'2e578c'`).
-
-![04-colors](https://raw.githubusercontent.com/fullscreen/squid/master/examples/screenshots/readme_04.png "chart(data, colors: ['5d9648'])")
-
-##### `:steps` changes the number of gridlines (default: `4`).
-
-![05-gridlines](https://raw.githubusercontent.com/fullscreen/squid/master/examples/screenshots/readme_05.png "chart(data, steps: 6)")
-
-##### `:ticks` shows/hides the ticks between the baseline and each category (default: `true`).
-
-![06-ticks](https://raw.githubusercontent.com/fullscreen/squid/master/examples/screenshots/readme_06.png "chart(data, ticks: false)")
-
-##### `:baseline` shows/hides the baseline (default: `true`).
-
-![07-baseline](https://raw.githubusercontent.com/fullscreen/squid/master/examples/screenshots/readme_07.png "chart(data, baseline: false)")
-
-##### `:every` specifies how often to show category labels on the baseline (default: `1`).
-
-![08-every](https://raw.githubusercontent.com/fullscreen/squid/master/examples/screenshots/readme_08.png "chart(data, every: 2)")
-
-##### `:legend` shows/hides the legend (default: `true`).
-
-![09-legend](https://raw.githubusercontent.com/fullscreen/squid/master/examples/screenshots/readme_09.png "chart(data, legend: false)")
-
-##### `:legend` can also set the right and bottom margins of the legend (default: `{right: 0, bottom: 15}`).
-
-![10-legend-offset](https://raw.githubusercontent.com/fullscreen/squid/master/examples/screenshots/readme_10.png "chart(data, legend: {right: 50})")
-
-##### `:format` changes the format of the axis labels. Can be `:integer` (default), `:float`, `:percentage`, `:currency`, or `:seconds`.
-
-![11-format](https://raw.githubusercontent.com/fullscreen/squid/master/examples/screenshots/readme_11.png "chart(data, format: :percentage)")
-
-##### `:label` shows/hides the value for each point in the graph (default: `false`).
-
-![12-label](https://raw.githubusercontent.com/fullscreen/squid/master/examples/screenshots/readme_12.png "chart(data, label: true)")
-
-##### `:border` shows/hides a border around the graph (default: `false`).
-
-![13-border](https://raw.githubusercontent.com/fullscreen/squid/master/examples/screenshots/readme_13.png "chart(data, border: true)")
-
-##### `:height` changes the height of the graph (default: `250`).
-
-![14-height](https://raw.githubusercontent.com/fullscreen/squid/master/examples/screenshots/readme_14.png "chart(data, height: 150)")
-
-Multiple series
----------------
-
-By providing multiple key/values `data` to the `chart` method, you can plot multiple series on a graph.
-
-For instance, the following code generates the graph below:
-
-```ruby
-data = {safari:  {2013 => 43.2, 2014 => 46.1, 2015 => 50.7},
-       firefox:  {2013 => 56.8, 2014 => 53.9, 2015 => 49.3}}
-chart data, labels: true, format: :percentage
-```
-
-![15-multiple-columns](https://raw.githubusercontent.com/fullscreen/squid/master/examples/screenshots/readme_15.png "chart(data, label: true, format: :percentage)")
-
-When plotting multiple series, the option `type: :stack` can be set to display stacked columns:
-
-![16-multiple-stacks](https://raw.githubusercontent.com/fullscreen/squid/master/examples/screenshots/readme_16.png "chart(data, type: :stack, format: :percentage)")
-
-Any value set for the `:color`, `:format`, `:line_width` and `:label` options will be applied to the first series only:
-
-![17-singular-options](https://raw.githubusercontent.com/fullscreen/squid/master/examples/screenshots/readme_17.png "chart data, type: :line, color: '6f3d79', format: :percentage, line_width: 0.5, label: true")
-
-To customize each series, use the _plural_ options `:colors`, `:formats`, `:line_widths` and `:labels` instead:
-
-![18-plural-options](https://raw.githubusercontent.com/fullscreen/squid/master/examples/screenshots/readme_18.png "chart data, type: :line, colors: ['6f3d79', '7d807f'], formats: [:percentage, :percentage], line_widths: [0.5, 6], labels: [true, true]")
-
-
-Finally, the option `type: :two_axis` can be set to display two separate axes in your series belong to two different domains.
-
-For instance, the following code generates the graph below:
-
-```ruby
-data = {views: {2013 => 182, 2014 => 46, 2015 => 88},
-     earnings: {2013 => 104_323, 2014 => 27_234, 2015 => 14_123}}
-chart data, type: :two_axis
-```
-
-![19-two-axis](https://raw.githubusercontent.com/fullscreen/squid/master/examples/screenshots/readme_19.png "chart(data, type: :two_axis)")
+Please proceed to [http://fullscreen.github.io/squid](http://fullscreen.github.io/squid) for more details and examples.
 
 How to install
 ==============
@@ -134,7 +43,7 @@ How to install
 Squid requires **Ruby 2.1 or higher**.
 If used in a Rails project, requires **Rails 4.0 or higher**.
 
-To include in your project, add `gem 'squid', github: 'fullscreen/squid'` to the `Gemfile` file of your Ruby project.
+To include in your project, add `gem 'squid, ~> 1.0', github: 'fullscreen/squid'` to the `Gemfile` file of your Ruby project.
 
 How to generate the manual
 ==========================
@@ -145,9 +54,7 @@ How to contribute
 =================
 
 If you’ve made it this far in the README… thanks! :v:
-
-I’m about to release version 1 of this gem.
-Feel free to try it out and send issues or pull requests.
+Feel free to try it the gem, explore the code, and send issues or pull requests.
 
 All pull requests will have to make Travis and Code Climate happy in order to be accepted. :kissing_smiling_eyes:
 

data/Rakefile

@@ -7,17 +7,6 @@ task :manual do
   puts 'DONE!'
 end
 
-desc 'Generate the readme'
-task :readme do
-  print 'Building readme... '
-  require_relative 'examples/readme'
-  print 'Extracting screenshots...'
-  # Note: images 17, 18 and 19 need to be cropped at 309 (not 280) because they have more code
-  `convert -density 175 -colorspace sRGB readme.pdf -resize 50% -quality 100 -crop 744x320+0+280 examples/screenshots/readme_%02d.png`
-  puts 'DONE!'
-end
-
-
 require "rspec/core/rake_task"
 require "rspec/core/version"
 

data/lib/squid/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: squid
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta4
+  version: 1.0.0
 platform: ruby
 authors:
 - claudiob
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-08-27 00:00:00.000000000 Z
+date: 2015-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prawn
@@ -140,47 +140,7 @@ files:
 - 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-singular-options.rb
-- examples/readme/18-plural-options.rb
-- examples/readme/19-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/screenshots/readme_18.png
-- examples/screenshots/readme_19.png
+- examples/readme.png
 - examples/squid/baseline.rb
 - examples/squid/basic.rb
 - examples/squid/border.rb
@@ -230,9 +190,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.4.5.1

data/examples/readme/01-basic.rb

@@ -1,5 +0,0 @@
-filename = File.basename(__FILE__).gsub('.rb', '.pdf')
-Prawn::ManualBuilder::Example.generate(filename) do
-  data = {views: {2013 => 182, 2014 => 46, 2015 => 134}}
-  chart data
-end

data/examples/readme/02-type-point.rb

@@ -1,5 +0,0 @@
-filename = File.basename(__FILE__).gsub('.rb', '.pdf')
-Prawn::ManualBuilder::Example.generate(filename) do
-  data = {views: {2013 => 182, 2014 => 46, 2015 => 134}}
-  chart data, type: :point
-end

data/examples/readme/03-type-line.rb

@@ -1,5 +0,0 @@
-filename = File.basename(__FILE__).gsub('.rb', '.pdf')
-Prawn::ManualBuilder::Example.generate(filename) do
-  data = {views: {2013 => 182, 2014 => 46, 2015 => 134}}
-  chart data, type: :line, line_width: 10
-end

data/examples/readme/04-color.rb

@@ -1,5 +0,0 @@
-filename = File.basename(__FILE__).gsub('.rb', '.pdf')
-Prawn::ManualBuilder::Example.generate(filename) do
-  data = {views: {2013 => 182, 2014 => 46, 2015 => 134}}
-  chart data, colors: ['5d9648']
-end

data/examples/readme/05-gridlines.rb

@@ -1,5 +0,0 @@
-filename = File.basename(__FILE__).gsub('.rb', '.pdf')
-Prawn::ManualBuilder::Example.generate(filename) do
-  data = {views: {2013 => 182, 2014 => 46, 2015 => 134}}
-  chart data, steps: 6
-end

data/examples/readme/06-ticks.rb

@@ -1,5 +0,0 @@
-filename = File.basename(__FILE__).gsub('.rb', '.pdf')
-Prawn::ManualBuilder::Example.generate(filename) do
-  data = {views: {2013 => 182, 2014 => 46, 2015 => 134}}
-  chart data, ticks: false
-end

data/examples/readme/07-baseline.rb

@@ -1,5 +0,0 @@
-filename = File.basename(__FILE__).gsub('.rb', '.pdf')
-Prawn::ManualBuilder::Example.generate(filename) do
-  data = {views: {2013 => 182, 2014 => 46, 2015 => 134}}
-  chart data, baseline: false
-end

data/examples/readme/08-every.rb

@@ -1,5 +0,0 @@
-filename = File.basename(__FILE__).gsub('.rb', '.pdf')
-Prawn::ManualBuilder::Example.generate(filename) do
-  data = {views: {2013 => 182, 2014 => 46, 2015 => 134}}
-  chart data, every: 2
-end

data/examples/readme/09-legend.rb

@@ -1,5 +0,0 @@
-filename = File.basename(__FILE__).gsub('.rb', '.pdf')
-Prawn::ManualBuilder::Example.generate(filename) do
-  data = {views: {2013 => 182, 2014 => 46, 2015 => 134}}
-  chart data, legend: false
-end

data/examples/readme/10-legend-offset.rb

@@ -1,5 +0,0 @@
-filename = File.basename(__FILE__).gsub('.rb', '.pdf')
-Prawn::ManualBuilder::Example.generate(filename) do
-  data = {views: {2013 => 182, 2014 => 46, 2015 => 134}}
-  chart data, legend: {right: 50, bottom: 50}
-end

data/examples/readme/11-format.rb

@@ -1,5 +0,0 @@
-filename = File.basename(__FILE__).gsub('.rb', '.pdf')
-Prawn::ManualBuilder::Example.generate(filename) do
-  data = {views: {2013 => 182/3.62, 2014 => 46/3.62, 2015 => 134/3.62}}
-  chart data, format: :percentage
-end

data/examples/readme/12-labels.rb

@@ -1,5 +0,0 @@
-filename = File.basename(__FILE__).gsub('.rb', '.pdf')
-Prawn::ManualBuilder::Example.generate(filename) do
-  data = {views: {2013 => 182, 2014 => 46, 2015 => 134}}
-  chart data, label: true
-end

data/examples/readme/13-border.rb

@@ -1,5 +0,0 @@
-filename = File.basename(__FILE__).gsub('.rb', '.pdf')
-Prawn::ManualBuilder::Example.generate(filename) do
-  data = {views: {2013 => 182, 2014 => 46, 2015 => 134}}
-  chart data, border: true
-end

data/examples/readme/14-height.rb

@@ -1,5 +0,0 @@
-filename = File.basename(__FILE__).gsub('.rb', '.pdf')
-Prawn::ManualBuilder::Example.generate(filename) do
-  data = {views: {2013 => 182, 2014 => 46, 2015 => 134}}
-  chart data, height: 150
-end

data/examples/readme/15-multiple-columns.rb

@@ -1,5 +0,0 @@
-filename = File.basename(__FILE__).gsub('.rb', '.pdf')
-Prawn::ManualBuilder::Example.generate(filename) do
-  data = {safari:  {2013 => 43.2, 2014 => 46.1, 2015 => 50.7}, firefox:  {2013 => 56.8, 2014 => 53.9, 2015 => 49.3}}
-  chart data, label: true, format: :percentage
-end

data/examples/readme/16-multiple-stacks.rb

@@ -1,5 +0,0 @@
-filename = File.basename(__FILE__).gsub('.rb', '.pdf')
-Prawn::ManualBuilder::Example.generate(filename) do
-  data = {safari:  {2013 => 43.2, 2014 => 46.1, 2015 => 50.7}, firefox:  {2013 => 56.8, 2014 => 53.9, 2015 => 49.3}}
-  chart data, type: :stack, format: :percentage
-end

data/examples/readme/17-singular-options.rb

@@ -1,5 +0,0 @@
-filename = File.basename(__FILE__).gsub('.rb', '.pdf')
-Prawn::ManualBuilder::Example.generate(filename) do
-  data = {safari:  {2013 => 53.2, 2014 => 56.1, 2015 => 60.7}, firefox:  {2013 => 46.8, 2014 => 43.9, 2015 => 39.3}}
-  chart data, type: :line, color: '6f3d79', format: :percentage, line_width: 0.5, label: true
-end

data/examples/readme/18-plural-options.rb

@@ -1,5 +0,0 @@
-filename = File.basename(__FILE__).gsub('.rb', '.pdf')
-Prawn::ManualBuilder::Example.generate(filename) do
-  data = {safari:  {2013 => 53.2, 2014 => 56.1, 2015 => 60.7}, firefox:  {2013 => 46.8, 2014 => 43.9, 2015 => 39.3}}
-  chart data, type: :line, colors: ['6f3d79', '7d807f'], formats: [:percentage, :percentage], line_widths: [0.5, 6], labels: [true, true]
-end

data/examples/readme/19-two-axis.rb

@@ -1,5 +0,0 @@
-filename = File.basename(__FILE__).gsub('.rb', '.pdf')
-Prawn::ManualBuilder::Example.generate(filename) do
-  data = {earnings: {2013 => 104_323, 2014 => 27_234, 2015 => 74_123}, views: {2013 => 182, 2014 => 46, 2015 => 88}, uniques: {2013 => 153, 2014 => 36, 2015 => 78} }
-  chart data, type: :two_axis
-end

data/examples/readme/readme.rb

@@ -1,30 +0,0 @@
-Prawn::ManualBuilder::Example.generate 'readme.pdf' do
-  package 'readme' do |p|
-    p.name = 'Readme'
-
-    p.intro do
-    end
-
-    p.section 'Single series' do |s|
-      s.example '01-basic'
-      s.example '02-type-point'
-      s.example '03-type-line'
-      s.example '04-color'
-      s.example '05-gridlines'
-      s.example '06-ticks'
-      s.example '07-baseline'
-      s.example '08-every'
-      s.example '09-legend'
-      s.example '10-legend-offset'
-      s.example '11-format'
-      s.example '12-labels'
-      s.example '13-border'
-      s.example '14-height'
-      s.example '15-multiple-columns'
-      s.example '16-multiple-stacks'
-      s.example '17-singular-options'
-      s.example '18-plural-options'
-      s.example '19-two-axis'
-    end
-  end
-end

data/examples/readme.rb

@@ -1,7 +0,0 @@
-require 'squid'
-require 'prawn/manual_builder'
-Prawn::ManualBuilder.manual_dir = File.dirname(__FILE__)
-Prawn::Font::AFM.hide_m17n_warning = true
-Prawn::ManualBuilder::Example.generate 'readme.pdf', skip_page_creation: true do
-  load_package 'readme'
-end