active_charts 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 93c7d3297b3c8394585c573e9b4cea0a336fb88b
+  data.tar.gz: 89c376a47c453c945ad77d6ae14443c57aeadaa4
+SHA512:
+  metadata.gz: 58b57ffca3337c294788d2e6b5cbfb155a649c64f8f49d14ec2a18535225e028963c8e2e38a26607638edecf8d8d5ec17edaafda5bb0f91110e137193ba033cd
+  data.tar.gz: 9d4a711a3d3856f356a464244c63768f7fd66ed937f595442bf2e856074a239621d15760602f1c341d7cadaee7b26c9cd515cdfa58821845d5592b4c88bd9e0c

data/.gitignore

@@ -0,0 +1,13 @@
+.DS_Store
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.simplecov

@@ -0,0 +1,3 @@
+SimpleCov.start 'rails' do
+  # any custom configs like groups and filters can be here at a central place
+end

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.15.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at http://stephsun.com/tickets/active_charts/. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in active_charts.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 saaineui
+
+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,186 @@
+# ActiveCharts
+
+Beautiful, easy charts for ActiveRecord and Rails.
+
+[![View on Travis](https://travis-ci.org/saaineui/active_charts.svg?branch=master)](https://travis-ci.org/saaineui/active_charts)
+
+ActiveCharts is a charting toolset that integrates into ActiveRecord and ActionView for fast, easy business intelligence and data visualization on any Rails app. 
+
+ActiveCharts uses inline SVG wherever possible for simplicity and best performance on the web. Javascript is used only when absolutely necessary.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'active_charts'
+```
+
+And then execute:
+
+    $ bundle install
+
+Generate the default stylesheet and script files:
+
+    $ bundle exec active_charts install
+    
+Follow the command line instructions to include the files in your assets pipeline.
+
+## Usage
+
+ActiveCharts autoloads its view helpers into your Rails app. For every chart type available, there are helpers for raw data (array of arrays) and for ActiveRecord collections.
+
+### Chart Gallery
+
+You can view sample charts created with the latest version of ActiveCharts at the Chart Gallery: 
+ - [Chart Gallery](https://necker.herokuapp.com/active_charts "ActiveCharts Chart Gallery")
+
+### [Bar Charts](https://necker.herokuapp.com/active_charts#bar-charts)
+
+#### `bar_chart(collection, options = {})`
+
+ActiveCharts helpers all support multi-series data by default, so each 'row' of data should be wrapped in an array even if you are creating a single-series chart, e.g. `[[1], [2], [3]]` is a single-series data set with three datapoints.
+
+If you do have multiple series, include the columns in the same order in each row. `[[1, 2], [2, 4], [3, 9]]` is a valid multi-series data set for use with the `bar_chart` helper.
+
+_Note: ActiveCharts does not currently support negative values in its Bar Charts, but will in the future. Both Line Charts and Scatter Plots support all real numbers._
+
+```ruby
+# controller:
+@collection = [[a1, b1, c1], [a2, b2, c2], ... [a50, b50, c50]]
+@rows = ['Alabama', 'Alaska', ... 'Wyoming']
+@series_labels = ['Median Income', 'Percent White', 'GDP Per Capita']
+
+# view:
+<%= bar_chart(@collection, title: 'Census Data by State', rows: @rows, series_labels: @series_labels) %>
+```
+
+#### `bar_chart_for(resource_collection, columns, options = {})`
+
+If you have an ActiveRecord model named State with columns named `:median_income`, `:percent_white`, and `:gdp_per_capita` that correspond to the same series as in the above example, you will get a similar chart with the following code in your view. ActiveCharts will automatically use the `:name` column to populate the rows array. Manual methods for setting rows are described below.
+
+```ruby
+# view:
+<%= bar_chart_for(State.all, [:median_income, :percent_white, :gdp_per_capita], title: 'Census Data by State') %>
+```
+
+#### Options
+
+All charts have the following options unless indicated otherwise:
+
+ - `:title` - Specifies a string to include in the `<figcaption>` element as the chart title. Default is “” (i.e. nothing).
+ - `:class` - Specifies a string to append to the CSS class for the `<figure>` element which contains the chart title, svg data, and legend.  Default is “” (i.e. nothing).
+ - `:data_formatters` - Specifies an array of symbols for special formatting of data columns. If not set, all data will be floating point numbers formatted using the `number_with_delimiter` helper.
+    - Available formatters are: `:percent`, `:date`, `:currency`, `:rounded`, `:none`.
+ - `:max_values` - Specifies an array of max y values for each data column, in column order (e.g. [300000, 1, 300000] might be passed for the above example, if we want Median Income and GDP Per Capita rendered using the same scale). Default will be the largest value in each column, as calculated by ActiveCharts.
+ - `:single_y_scale` - Set to true if you want to force a single y scale across all of your columns. (Note: if `:max_values` is set to valid data, it will override this setting.)
+ - `:series_labels` - Specifies an array of strings to use in the legend. (Default on basic helpers is []. Default on `_for` helpers is an array of column names.)
+ - `:label_height` - Specifies the number of pixels high the chart text labels should be. (Default is 10.) 
+
+All rectangular charts (Bar Charts, Scatter Plots, and Line Charts) have the following options unless indicated otherwise:
+
+ - `:height` - Specifies the number of pixels high the chart should be. (Default is 400.)
+ - `:rows` - Specifies an array of strings to use to label bars or datapoints.  Default is [] (i.e. nothing).
+ 
+Bar Charts have the following additional options:
+
+ - `:bar_width` - Specifies the number of pixels wide each bar should be. (Default is 40.) Width is automatically calculated from `:bar_width`.
+ 
+### XY Charts in ActiveCharts: Scatter Plots and Line Charts
+ 
+ActiveCharts supports two types of charts that plot data on an XY grid: Scatter Plots and Line Charts. Each datapoint in these charts is represented by a two-item array, with the x value in the 0 position and the y value in the 1 position: `[x, y]`.
+
+Use these charts to plot time-series data or to visualize the relationship between two variables.
+
+`[[[1, 1.1]], [[2, 1.9]], [[3, 3.6]]]` is a valid single-series Scatter Plot or Line Chart data set with three datapoints (note the extra array wrapping each row is still required). 
+
+For multiple series, again include the columns in the same order in each row. `[[[1, 1.1], [3, 5]], [[2, 1.9], [0, 7]]]` is a valid multi-series data set for use with the `scatter_plot` and `line_chart` helpers.
+
+### [Scatter Plots](https://necker.herokuapp.com/active_charts#scatter-plots)
+
+In the following examples, we plot `:median_income` vs. `:gdp_per_capita` for each state.
+
+#### `scatter_plot(collection, options = {})`
+
+```ruby
+# controller:
+@collection = [[[x1, y1]], [[x2, y2]], ... [[x50, y50]]]
+@rows = ['Alabama', 'Alaska', ... 'Wyoming']
+@series_labels = ['Median Income', 'GDP Per Capita']
+
+# view:
+<%= scatter_plot(@collection, title: 'Census Data by State', rows: @rows, series_labels: @series_labels) %>
+```
+
+#### `scatter_plot_for(resource_collection, columns, options = {})`
+
+The ActiveRecord model helper `scatter_plot_for` works similarly to `bar_chart_for`. This code will produce a similar chart to the above example.
+
+```ruby
+# view:
+<%= scatter_plot_for(State.all, [:median_income, :gdp_per_capita], title: 'Census Data by State') %>
+```
+
+A big difference to be aware of with `scatter_plot_for` and `line_chart_for` is that these XY helpers only support one column as the source for the x axis data (e.g. _a_ vs. _b_ and _a_ vs. _c_). If you wish to plot _a_ vs. _b_ and _c_ vs. _d_, you will need to use the generic helpers `scatter_plot` and `line_chart`.
+
+The first column specified in the `columns` array is the x value for all data points for the row, and the remaining columns will be the y value(s).
+
+The following will print each state's median income vs. the % of its population that's white in a series of red dots, and the median income vs. its GDP per capita in a series of orange dots. 
+
+```ruby
+# view:
+<%= scatter_plot_for(State.all, [:median_income, :percent_white, :gdp_per_capita], title: 'Census Data by State') %>
+```
+
+#### Options
+
+Both XY Charts (Scatter Plots and Line Charts) have the following options unless indicated otherwise:
+
+ - `:width` - Specifies the number of pixels high the chart should be. (Default is 600.)
+
+### [Line Charts](https://necker.herokuapp.com/active_charts#line-charts)
+
+Line Chart helpers work almost exactly the same as Scatter Plot helpers. Please review the previous section for detailed instructions.
+
+_Note: The path for each series will be drawn in the given order, so please sort your collection in X order before passing it to `line_chart` or `line_chart_for` or your line will be crooked._
+
+#### `line_chart(collection, options = {})`
+
+```ruby
+# controller:
+@collection = [[[x1, y1]], [[x2, y2]], ... [[x50, y50]]]
+@rows = ['Alabama', 'Alaska', ... 'Wyoming']
+@series_labels = ['Median Income', 'GDP Per Capita']
+
+# view:
+<%= line_chart(@collection, title: 'Census Data by State', rows: @rows, series_labels: @series_labels) %>
+```
+
+#### `line_chart_for(resource_collection, columns, options = {})`
+
+```ruby
+# view:
+<%= line_chart_for(State.all.order(:name), [:median_income, :gdp_per_capita], title: 'Census Data by State') %>
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 
+
+Then, run the tests:
+
+    $ bundle exec rspec
+    $ bundle exec cucumber
+    $ bundle exec rake jasmine
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/saaineui/active_charts. 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.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the ActiveCharts project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/saaineui/active_charts/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+require 'jasmine'
+load 'jasmine/tasks/jasmine.rake'

data/active_charts.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "active_charts/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "active_charts"
+  spec.version       = ActiveCharts::VERSION
+  spec.authors       = ["saaineui"]
+
+  spec.summary       = %q{Beautiful, easy charts for ActiveRecord and Rails.}
+  spec.description   = %q{Charting toolset that integrates into ActiveRecord and ActionView for fast, easy business intelligence and data visualization on any Rails app. Uses inline SVG wherever possible for best performance on the web. Javascript is used only when absolutely necessary.}
+  spec.homepage      = "https://github.com/saaineui/active_charts"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  
+  spec.required_ruby_version = '>= 2.2.2'
+  
+  spec.add_dependency "rails", ">= 5.0.1"
+  spec.add_dependency 'sass-rails', '~> 5.0'
+  spec.add_dependency "thor"
+  
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.5"
+  spec.add_development_dependency "rspec", "~> 3.6"
+  spec.add_development_dependency "rspec-rails"
+  spec.add_development_dependency "cucumber"
+  spec.add_development_dependency "aruba"
+  spec.add_development_dependency "jasmine"
+  spec.add_development_dependency "simplecov"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "active_charts"
+
+# 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(__FILE__)

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/exe/active_charts

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require 'active_charts/cli'
+ActiveCharts::CLI.start

data/lib/active_charts.rb

@@ -0,0 +1,27 @@
+require 'rails'
+
+module ActiveCharts
+  class Engine < ::Rails::Engine
+    initializer 'active_charts.initialize' do
+      ActiveSupport.on_load(:action_view) do
+        include ActiveCharts::Helpers::BarChartHelper
+        include ActiveCharts::Helpers::ScatterPlotHelper
+        include ActiveCharts::Helpers::LineChartHelper
+      end
+    end
+
+    config.eager_load_namespaces << ActiveCharts
+  end
+  
+  extend ActiveSupport::Autoload
+
+  eager_autoload do
+    autoload :Helpers
+    autoload :Chart
+    autoload :RectangularChart
+    autoload :XYChart
+    autoload :BarChart
+    autoload :ScatterPlot
+    autoload :LineChart
+  end  
+end

data/lib/active_charts/bar_chart.rb

@@ -0,0 +1,94 @@
+module ActiveCharts
+  class BarChart < RectangularChart
+    DEFAULT_BAR_WIDTH = 40
+    
+    attr_reader :x_labels, :bar_width, :bars_count, :x_offset, :y_offset, 
+                :section_width, :max_bar_height, :max_values, :y_multipliers
+    
+    def chart_svg_tag
+      inner_html = [grid_rect_tag, bars, bottom_label_text_tags].flatten.join('
+          ')
+      
+      tag.svg(inner_html.html_safe, svg_options)
+    end
+    
+    def bars
+      whitelist = %w[width height x y class]
+      
+      bars_specs.flatten.map do |bar| 
+        label = formatted_val(bar[:val], bar[:formatter])
+        
+        [%(<rect #{tag_options(bar.merge(width: bar_width), whitelist)} />),
+         tag.text(label, label_options(bar))]
+      end
+    end
+
+    def bars_specs
+      collection.map.with_index do |row, row_index|
+        row.map.with_index do |cell, col_index|
+          height = bar_height(cell, col_index)
+          x = bar_x(col_index, row_index)
+          y = grid_height - height
+
+          { height: height, x: x, y: y, class: bar_classes(col_index), val: cell, 
+            formatter: data_formatters[col_index] }
+        end
+      end
+    end
+    
+    def bottom_label_text_tags
+      x_labels.map.with_index do |label, index| 
+        tag.text(label, x: section_width * (index + 0.5), y: grid_height + label_height * 1.5)
+      end.join
+    end
+
+    private
+
+    def process_options(options)
+      super
+      
+      @bar_width = options[:bar_width] || DEFAULT_BAR_WIDTH
+      @x_labels = options[:rows] || []
+    end
+    
+    def prereq_calcs
+      @bars_count = columns_count * rows_count
+    end
+    
+    def width_calcs(_values)
+      @grid_width = @svg_width = compute_svg_width
+      @section_width = rows_count.zero? ? svg_width : svg_width / rows_count.to_d
+      @x_offset = bar_width / 2
+    end
+    
+    def compute_svg_width
+      (bar_width * bars_count) + (rows_count * MARGIN * (1 + columns_count))
+    end
+    
+    def height_calcs(_values)
+      @grid_height = svg_height - label_height * 2
+      @max_bar_height = grid_height - label_height * 3
+      @y_offset = label_height / 2
+      @y_multipliers = max_values.map { |max| Util.multiplier(max, max_bar_height) }
+    end 
+    
+    def label_options(bar)
+      {
+        x: bar[:x] + x_offset,
+        y: bar[:y] - y_offset
+      }
+    end
+      
+    def bar_classes(col)
+      ['ac-bar-chart-bar', series_class(col)].join(' ')
+    end
+    
+    def bar_height(cell, col_index)
+      Util.safe_to_dec(cell) * y_multipliers[col_index]
+    end
+    
+    def bar_x(col, row)
+      ((bar_width + MARGIN) * Util.grid_index(columns_count, col, row)) + (MARGIN * (row + 1))
+    end
+  end
+end