plasticine 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2041b85898391b69adc6c941713bfde0dd46d8a5fa55c95387770c5621f0403c
+  data.tar.gz: 4d3d890d23bd43f8c4e94e66c956126571cfc16fc5dfb0794536985ef608361a
+SHA512:
+  metadata.gz: e252e948880b7a6ef76fc06ae953f6e34d51f314f246a2e2acd0d9105f10d76b5698c7d4cdff7ea034c3629511def2d49a2579adc879e2d79ceaa3e7202d22e9
+  data.tar.gz: 4dbaa2ec0511d9ac82557b9df5a3fd2e36e6b0fc96ddd46f5e671d0dae781a321c43198b41b8c4738cb42f42bc5a5790314c847db0eefdd38980d114a0c0e478

data/.gitignore

@@ -0,0 +1,9 @@
+*.gem
+.bundle
+.metrics
+.rspec
+Gemfile.lock
+coverage/*
+pkg/*
+spec/dummy/log
+tmp/*

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 1.9.3
+  - 1.9.2

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in plasticine.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,8 @@
+Original work Copyright (c) 2012 De Marque inc.
+Modified work Copyright (c) 2015 Alchimik inc.
+
+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,18 @@
+Plasticine
+=======
+
+[Description]
+
+Install
+-------
+
+In your Gemfile:
+
+```ruby
+gem 'plasticine'
+```
+
+Copyright
+---------
+
+Copyright (c) 2015 Alchimik. See LICENSE for further details.

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler"
+require "rspec/core/rake_task"
+
+Bundler::GemHelper.install_tasks
+
+desc "Run all specs in spec directory"
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = "spec/**/*_spec.rb"
+end
+
+task default: :spec

data/app/assets/javascripts/plasticine/base.coffee

@@ -0,0 +1,13 @@
+class Plasticine
+  constructor: () ->
+    @visuals = []
+
+    if @d3IsLoaded()
+      $('div.plasticine').each (i, visual) =>
+        switch $(visual).data('visual')
+          when 'column' then @visuals.push new PlasticineColumn $(visual)
+
+  d3IsLoaded: () -> if d3? then true else false
+
+
+$ -> new Plasticine

data/app/assets/javascripts/plasticine/column.coffee

@@ -0,0 +1,243 @@
+class @PlasticineColumn
+  constructor: (@holder) ->
+    @holder = $('.plasticine-column')
+
+    @setLocale()
+    @drawTooltip()
+
+    width = @holderWidth()
+    height = @holder.height()
+
+    @xScale = d3.scale.ordinal()
+    @setXScaleRange()
+
+    @yScale = d3.scale.linear().range([height,0])
+
+    @setXAxis()
+    @setYAxis()
+
+    @svg = d3.select("##{@holder.attr('id')}").append('svg').style('width', width).style('height', height).append('g')
+
+    d3.json @holder.data('url'), (data) => @build(data)
+
+
+  build: (data) ->
+    columnIds = data.columns[0].y_values.map (d,i) -> "col#{i+1}"
+
+    @colGroup = d3.scale.ordinal().range(columnIds).domain(columnIds)
+
+    @xAxisFormat = data.axis_x_format
+    @yAxisFormat = data.axis_y_format
+    @yAxisTickCount = data.axis_y_tick_count
+    @quarterStartMonth = Number(data.quarter_start_month)
+
+    data.columns.forEach (d) =>
+      y0 = 0
+      d.yValues = @colGroup.domain().map (name,i) => { name: name, y0: y0, y1: y0 += @formatValue(d.y_values[i], @yAxisFormat) }
+      d.total = d.yValues[d.yValues.length - 1].y1
+      d.x = @formatValue(d.x_value, @xAxisFormat)
+
+    @xScale.domain data.columns.map( (d) -> d.x )
+    @yScale.domain [0, d3.max(data.columns, (d) => d.total * @holder.data('y-spacing-ratio'))]
+
+    @drawYAxis()
+
+    @columns = @svg.append('g').attr("class", "columns").selectAll('.column').data(data.columns)
+    @refreshColumns()
+
+    @drawXAxis()
+
+    d3.select(window).on("resize." + @holder.attr("id"), () => @resizeX())
+
+
+  drawTooltip: () -> @holder.append('<div class="tooltip"></div>')
+
+  drawXAxis: () ->
+    height = @holder.height()
+    @svg.append('g').attr('class', 'x axis')
+      .attr('transform', 'translate(0,' + height + ')')
+      .call @xAxis
+
+    @refreshXAxis()
+
+
+  drawYAxis: () ->
+    group = @svg.append("g").attr("class", "y axis").call @yAxis
+    group.selectAll("g").filter((d) -> d).classed("minor", true)
+
+    @refreshYAxis()
+
+
+  formatValue: (value, format) ->
+    switch format
+      when 'date' then new Date(value)
+      else value
+
+  holderWidth: () -> @holder.width()
+
+  refreshXAxis: () ->
+    @setXAxis()
+    @svg.select('.x.axis').call @xAxis
+
+
+  refreshYAxis: () ->
+    @setYAxis()
+    @svg.select('.y.axis').call @yAxis
+
+
+  setXAxis: () ->
+    @xAxis = d3.svg.axis().scale(@xScale).orient('bottom')
+    @xAxis.tickSize -@holder.height()
+
+    switch @xAxisFormat
+      when 'date' then @xAxis.tickFormat(d3.time.format('%b'))
+      when 'quarter' then @xAxis.tickFormat (d) => @toQuarter(d)
+      when 'year' then @xAxis.tickFormat (d) => @toYear(d)
+      when 'money' then @xAxis.tickFormat (d) => @toPrice(d)
+
+
+  setYAxis: () ->
+    @yAxis = d3.svg.axis().scale(@yScale).orient("left");
+    @yAxis.tickSize -@holderWidth()
+    @yAxis.ticks @yAxisTickCount
+
+    switch @yAxisFormat
+      when 'date' then @yAxis.tickFormat(d3.time.format('%b'))
+      when 'money' then @yAxis.tickFormat (d) => @toPrice(d)
+
+  hideTooltip: () -> @holder.find('.tooltip').hide()
+
+  refreshColumns: () ->
+    self = this
+
+    $('g.column').remove()
+
+    @columns.enter().append('g')
+      .attr('class', 'column')
+      .attr('data-x-val', (d) -> d.x_value)
+      .attr('transform', (d) => 'translate(' + @xScale(d.x) + ',0)')
+      .attr('x', (d) => @xScale(d.x))
+      .on("mouseover", (d) -> self.showTooltip(@, d))
+      .on("mouseout", (d) -> self.hideTooltip(@))
+    @columns.exit().remove()
+
+    @columns.selectAll('rect')
+      .data((d) -> d.yValues)
+      .enter()
+      .append('rect')
+      .attr('width', @xScale.rangeBand())
+      .attr('y', (d) => @yScale d.y1)
+      .attr('height', (d) => @yScale(d.y0) - @yScale(d.y1))
+      .attr('class', (d) => @colGroup d.name)
+
+
+  resizeX: () ->
+    d3.select(@svg.node().parentNode).style('width', @holderWidth() + 'px')
+
+    @setXScaleRange()
+
+    @refreshXAxis()
+    @refreshYAxis()
+    @hideTooltip()
+    @refreshColumns()
+
+
+  setLocale: () ->
+    french = d3.locale(
+      "decimal": ",",
+      "thousands": " ",
+      "grouping": [3],
+      "currency": ["$", ""],
+      "dateTime": "%a %b %e %X %Y",
+      "date": "%d-%m-%Y",
+      "time": "%H:%M:%S",
+      "periods": ["AM", "PM"],
+      "days": ["Dimanche", "Lundi", "Mardi", "Mercredi", "Jeudi", "Vendredi", "Samedi"],
+      "shortDays": ["Dim", "Lun", "Mar", "Mer", "Jeu", "Ven", "Sam"],
+      "months": ["Janvier", "Février", "Mars", "Avril", "Mai", "Juin", "Juillet", "Août", "Septembre", "Octobre", "Novembre", "Décembre"],
+      "shortMonths": ["Jan", "Fev", "Mar", "Avr", "Mai", "Jun", "Jul", "Aou", "Sep", "Oct", "Nov", "Dec"]
+    )
+
+    d3.time.format = french.timeFormat
+    d3.format = french.numberFormat
+
+
+  setXScaleRange: () ->
+    columnsMargin = @holder.data('columns-margin')
+    columnsLeftPadding = @holder.data('columns-left-padding')
+    columnsRightPadding = @holder.data('columns-right-padding')
+    width = @holderWidth()
+
+    @xScale = @xScale.rangeRoundBands([columnsLeftPadding, width - columnsRightPadding], columnsMargin, 0)
+
+
+  showTooltip: (bar, data) ->
+    barNode = $($(bar).find('rect:last-child')[0])
+    barX = $(bar).attr('x')
+    barY = barNode.attr('y')
+
+    xPosition = parseInt(barX) + @holder.offset().left
+    yPosition = parseInt(barY) + @holder.offset().top
+
+    tooltip = @holder.find('.tooltip')
+
+    tooltip.html(data.tooltip)
+    tooltip.fadeIn 200
+
+    tooltipX = xPosition - (tooltip.outerWidth() / 2) + (parseInt(barNode.attr("width")) / 2)
+
+    d3.select(".tooltip")
+      .style("left", tooltipX + "px")
+      .style("top", (yPosition - tooltip.outerHeight()) + "px")
+
+
+  toPrice: (amount) ->
+    if amount is 0
+      price = "0"
+    else
+      price = String(amount)[0..-3]
+      price = "0" if price is ""
+
+      price = switch price.length
+        when 4 then [price.slice(0, 1), ' ', price.slice(1)].join('')
+        when 5 then [price.slice(0, 2), ' ', price.slice(2)].join('')
+        when 6 then [price.slice(0, 3), ' ', price.slice(3)].join('')
+        when 7 then [price.slice(0, 4), ' ', price.slice(4)].join('')
+        else price
+
+      # Show decimals
+      #price += ',' + String(amount).slice(-2)
+
+    price += '$'
+
+
+  toQuarter: (strDate) ->
+    date = new Date(strDate + 'T12:00:00')
+
+    month = date.getMonth() + 1
+    monthEquiv = (month + (13 - @quarterStartMonth)) % 12
+
+    value = switch
+      when monthEquiv <= 3 then 'Q1'
+      when monthEquiv <= 6 then 'Q2'
+      when monthEquiv <= 9 then 'Q3'
+      else 'Q4'
+
+    year = Number(date.getFullYear())
+
+    if (value is "Q1" and @quarterStartMonth >= 10) or ((value is "Q1" or value is "Q2") and @quarterStartMonth >= 7 and @quarterStartMonth < 10)
+      year += 1
+
+    value += " #{year}"
+    value
+
+
+  toYear: (strDate) ->
+    date = new Date(strDate + 'T12:00:00')
+
+    year = Number(date.getFullYear())
+
+    if @quarterStartMonth >= 7 and (date.getMonth() + 1) >= 7
+      year += 1
+
+    year

data/app/assets/javascripts/plasticine/index.js

@@ -0,0 +1,3 @@
+//= require d3
+//= require ./base
+//= require ./column

data/app/assets/stylesheets/plasticine/base.scss

@@ -0,0 +1 @@
+.plasticine{border:3px solid #f00;}

data/app/assets/stylesheets/plasticine/column.scss

@@ -0,0 +1,44 @@
+div.plasticine-column{border:none;clear:both;height:500px;margin:0;padding:0;width:100%;
+  svg{overflow:visible;height:100%;width:100%;}
+
+  path{fill:none;opacity:0;}
+
+  g.axis{shape-rendering:crispEdges;
+    g.tick {
+      line{stroke:#efefef;}
+      .minor line {stroke:#efefef;}
+      text{text-transform:uppercase;fill:#999;font-size:1.4rem;font-weight:500;}
+    }
+
+    &.x g.tick{
+      line{opacity:0;}
+      text{
+        transform: translate(0px,10px);
+        -ms-transform: translate(0px,10px);
+        -webkit-transform: translate(0px,10px);
+        -moz-transform: translate(0px,10px);
+      }
+    }
+
+    &.y g.tick{
+      text{text-align:right;}
+    }
+  }
+
+  g.columns g.column{
+    rect{fill:#24b4ca;}
+    rect.col1{fill:#45c8dc;}
+    rect.col2{fill:#7fd7e5;}
+    rect.col3{fill:#a6e5ee;}
+    rect.col4{fill:#c2edf5;}
+
+  }
+
+  .tooltip{background:#fff;border:1px solid #eee;border-radius:1rem;box-shadow:0px 0px 4px 0px rgba(0,0,0,0.1);display:none;margin-top:-3px;padding:1rem 2rem;position:absolute;
+    p{font-size:1.5rem;margin:0;padding:0;}
+
+    &:after, &:before {border:solid transparent;content:" ";height:0;left:50%;pointer-events:none;position:absolute;top:100%;width:0;}
+    &:after {border-color:rgba(255, 255, 255, 0);border-top-color:#ffffff;border-width:12px;margin-left:-12px;}
+    &:before {border-color:rgba(238, 238, 238, 0);border-top-color:#eeeeee;border-width:13px;margin-left:-13px;}
+  }
+}

data/app/assets/stylesheets/plasticine/index.css

@@ -0,0 +1,4 @@
+/*
+*= require ./base
+*= require ./column
+*/

data/app/controllers/plasticine_controller.rb

@@ -0,0 +1,53 @@
+class PlasticineController < ApplicationController
+  before_action :authenticate
+
+  def show
+    if @granted
+      # set_default_to if params[:from] and not params[:to]
+
+      builder = "Plasticine::Builder::#{params[:nature].camelize}".constantize.new(params[:id], params)
+
+      visual_model.build builder
+
+      respond_to do |format|
+        format.json { render json: builder.to_json }
+      end
+    else
+      respond_to do |format|
+        format.json { render json: { 'state' => 'access_refused' } }
+      end
+    end
+  end
+
+
+private
+
+  def authenticate
+    auth = Plasticine::Authentication.new(request.url, params)
+
+    @granted = (auth.valid_token? and not auth.expired?)
+  end
+
+  def visual_model
+    name = params[:id].underscore.camelize + 'Visual'
+
+    begin
+      name.constantize.new(params)
+    rescue
+      raise "Plasticine: You must defined #{name}"
+    end
+  end
+
+  def set_default_to
+    if params[:nature] == 'line'
+      params[:to] = case params[:step]
+        when 'day' then (Time.now.utc - 1.day).end_of_day.iso8601
+        when 'week' then (Time.now.utc - 1.week).end_of_week.iso8601
+        when 'month' then (Time.now.utc - 1.month).end_of_month.iso8601
+        else Time.now.utc.iso8601
+      end
+    else
+      params[:to] = Time.now.utc.iso8601
+    end
+  end
+end