plasticine 1.1.0

data/config/locales/en.yml

@@ -0,0 +1,26 @@
+en:
+  date:
+    formats:
+      plasticine_date_without_day: "%B %Y"
+      plasticine_date_long: "%e %B %Y"
+      plasticine_date_long_without_year: "%e %B"
+      plasticine_day: "%e"
+      plasticine_year: "%Y"
+
+  plasticine:
+    base:
+      steps:
+        day: Day
+        week: Week
+        month: Month
+        quarter: Quarter
+        year: Year
+
+  time:
+    formats:
+      plasticine_date_without_day: "%B %Y"
+      plasticine_date_long: "%B %e, %Y"
+      plasticine_date_long_without_year: "%e %B"
+      plasticine_day: "%e"
+      plasticine_long: "%B %d, %Y %H:%M"
+      plasticine_year: "%Y"

data/config/locales/fr.yml

@@ -0,0 +1,26 @@
+fr:
+  date:
+    formats:
+      plasticine_date_without_day: "%B %Y"
+      plasticine_date_long: "%e %B %Y"
+      plasticine_date_long_without_year: "%e %B"
+      plasticine_day: "%e"
+      plasticine_year: "%Y"
+
+  plasticine:
+    base:
+      steps:
+        day: Jour
+        week: Semaine
+        month: Mois
+        quarter: Trimestre
+        year: Année
+
+  time:
+    formats:
+      plasticine_date_without_day: "%B %Y"
+      plasticine_date_long: "%e %B %Y"
+      plasticine_date_long_without_year: "%e %B"
+      plasticine_day: "%e"
+      plasticine_long: "%e %B %Y à %H:%M"
+      plasticine_year: "%Y"

data/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  resources :plasticine, only: [:index, :show], controller: "plasticine"
+end

data/lib/plasticine.rb

@@ -0,0 +1,23 @@
+module Plasticine
+  def self.localize(path, options={})
+    options.reverse_merge! format: :date_long
+
+    options[:format] = "plasticine_#{options[:format]}".to_sym
+
+    return I18n.localize(path, options)
+  end
+
+  def self.translate(path, options={})
+    I18n.translate("plasticine.#{path}", options)
+  end
+
+  def self.t(path, options={})
+    self.translate path, options
+  end
+end
+
+require "plasticine/authentication"
+require "plasticine/base_visual"
+require "plasticine/builder"
+require "plasticine/engine"
+require "plasticine/railtie"

data/lib/plasticine/authentication.rb

@@ -0,0 +1,43 @@
+require 'openssl'
+
+module Plasticine
+  class Authentication
+
+    def initialize(request_url, params={})
+      @request_url = request_url
+      @params = params
+    end
+
+    def expired?
+      @params[:timestamp] and Time.parse(@params[:timestamp]) + 12.hours < Time.now
+    end
+
+    def valid_token?
+      @params[:token] == tokenize
+    end
+
+    def tokenize
+      OpenSSL::HMAC.hexdigest(OpenSSL::Digest::SHA1.new, token_key, filtered_url)
+    end
+
+
+  private
+
+    def compacted_params
+      @params.map{ |k,v| "#{k}#{v}" if not reserved_params.include?(k.to_s) }.join
+    end
+
+    def filtered_url
+      url = @request_url.split('?').first.rpartition('/').first + compacted_params
+      url.chars.sort.join.gsub('/', '')
+    end
+
+    def reserved_params
+      ['action', 'class', 'controller', 'format', 'from', 'nature', 'step', 'to', 'token', 'tools', 'update_every', 'version']
+    end
+
+    def token_key
+      Rails.application.config.secret_key_base
+    end
+  end
+end

data/lib/plasticine/base_visual.rb

@@ -0,0 +1,11 @@
+module Plasticine
+  class BaseVisual
+    def initialize(params)
+      @params = params
+
+      @from = params[:from] ? Time.parse(params[:from]) : nil
+      @to = params[:to] ? Time.parse(params[:to]) : Time.now
+      @step = params[:step] || 'month'
+    end
+  end
+end

data/lib/plasticine/builder.rb

@@ -0,0 +1,43 @@
+module Plasticine::Builder
+  def self.period(start_at, end_at, options={})
+    options.reverse_merge!(step: 'day')
+
+    start_at_format = case
+      when options[:step] == 'month' then :date_without_day
+      when options[:step] == 'year' then :year
+      when start_at.year != end_at.year then :date_long
+      when start_at.month != end_at.month then :date_long_without_year
+      else :day
+    end
+
+    end_at_format = case options[:step]
+      when 'month' then :date_without_day
+      when 'year' then :year
+      else :date_long
+    end
+
+    content = []
+    content << Plasticine.localize(start_at, format: start_at_format)
+    content << (['month', 'year'].include?(options[:step]) ? Plasticine.t('date.period.to_month') : Plasticine.t('date.period.to'))
+    content << Plasticine.localize(end_at, format: end_at_format)
+
+    content[0].capitalize!
+
+    return content.join(' ')
+  end
+
+  def self.get_step_from_interval(interval)
+    days = (interval / (3600 * 24)).to_i.abs
+
+    return case days
+      when 0..5 then 'day'
+      when 6..27 then 'week'
+      when 28..88 then 'month'
+      when 89..363 then 'quarter'
+      else 'year'
+    end
+  end
+end
+
+require 'plasticine/builder/base'
+require 'plasticine/builder/column'

data/lib/plasticine/builder/base.rb

@@ -0,0 +1,58 @@
+class Plasticine::Builder::Base
+  attr_accessor :visual
+
+  def initialize(id, options={})
+    options.reverse_merge! from: nil, to: nil, step: nil
+
+    @from = options[:from] ? Time.parse(options[:from]) : nil
+    @to = options[:to] ? Time.parse(options[:to]) : Time.now
+
+    @visual = { id: id }
+    @visual[:step] = options[:step] if options[:step]
+    @visual[:title] = t('title')
+    @visual[:period] = Plasticine::Builder.period(@from, @to, step: @visual[:step]) if @from
+  end
+
+  def close_visual
+    # Hooks before closing a visual
+  end
+
+  def id
+    @visual[:id]
+  end
+
+  def l(date, options={})
+    options.reverse_merge!(format: :date_long)
+
+    Plasticine.localize(date, options)
+  end
+
+  def period
+    @visual[:period]
+  end
+
+  def set_period_from_data(data)
+    @from = data.first
+    @to = data.last
+
+    @visual[:step] = Plasticine::Builder.get_step_from_interval(data[1] - data[0]) if not @visual[:step]
+
+    @visual[:period] = Plasticine::Builder.period @from, @to, step: @visual[:step]
+  end
+
+  def t(path, vars={})
+    vars.reverse_merge! default: ''
+
+    Plasticine.translate("#{id.gsub('-', '_')}.#{path}", vars)
+  end
+
+  def title
+    @visual[:title]
+  end
+
+  def to_json
+    close_visual
+
+    @visual.to_json
+  end
+end

data/lib/plasticine/builder/column.rb

@@ -0,0 +1,41 @@
+class Plasticine::Builder::Column < Plasticine::Builder::Base
+  def initialize(id, options={})
+    super
+
+    @visual.merge! columns: [], nature: 'column', axis_x_format: :string, axis_y_format: :number, axis_y_tick_count: 10, quarter_start_month: 1
+    @columns = {}
+  end
+
+  def add_column(x, y, options={})
+    options.reverse_merge! tooltip: nil
+
+    @columns[x] = [] if not @columns[x]
+
+    @columns[x] << { tooltip: options[:tooltip], y: y }
+  end
+
+  def axis_x_format=(format)
+    @visual[:axis_x_format] = format
+  end
+
+  def axis_y_format=(format)
+    @visual[:axis_y_format] = format
+  end
+
+  def axis_y_tick_count=(tick_count)
+    @visual[:axis_y_tick_count] = tick_count
+  end
+
+  def quarter_start_month=(month)
+    @visual[:quarter_start_month] = month
+  end
+
+
+  def close_visual
+    super
+
+    @columns.each do |x, data|
+      @visual[:columns] << { x_value: x, y_values: data.map{ |d| d[:y] }, tooltip: data[0][:tooltip] }
+    end
+  end
+end

data/lib/plasticine/engine.rb

@@ -0,0 +1,7 @@
+module Plasticine
+  #*************************************************************************************
+  # Make the gem behave as an engine.
+  #*************************************************************************************
+  class Engine < Rails::Engine
+  end
+end

data/lib/plasticine/helpers.rb

@@ -0,0 +1,81 @@
+module Plasticine::Helpers
+  def d3_include_tag
+    ('<![if ! lt IE 9]>' + javascript_include_tag("d3") + '<![endif]>').html_safe
+  end
+
+  def column_visual(id, options={})
+    PlasticineTagHelper.new(self, id, options[:from], options[:to], options[:step]).column(options)
+  end
+
+
+  class PlasticineTagHelper
+    attr_reader :rails_helpers
+
+    delegate :content_tag,    to: :rails_helpers
+    delegate :link_to,        to: :rails_helpers
+    delegate :plasticine_url, to: :rails_helpers
+
+    def initialize(rails_helpers, id, from, to, step)
+      @rails_helpers = rails_helpers
+      @id = id
+      @from = from
+      @to = to
+      @step = step || 'month'
+    end
+
+    def column(options={})
+      options.reverse_merge! columns_left_padding: 20, columns_right_padding: 20, columns_margin: 0.2, y_spacing_ratio: 1.10
+
+      options[:data] = {
+        columns_left_padding: options.delete(:columns_left_padding),
+        columns_right_padding: options.delete(:columns_right_padding),
+        columns_margin: options.delete(:columns_margin),
+        y_spacing_ratio: options.delete(:y_spacing_ratio)
+      }
+
+      visual 'column', options
+    end
+
+
+  private
+
+    def build_url(nature, options={})
+      params = { from: @from, format: 'json', id: @id, nature: nature, nonce: SecureRandom.hex(20), step: @step, timestamp: Time.now.utc.iso8601, to: @to, version: 'v1' }
+
+      options.each { |k,v| params[k] = v if not ['class', 'data', 'tools'].include? k.to_s }
+
+      params[:token] = build_url_token(params)
+
+      @url = plasticine_url(params)
+    end
+
+    def build_url_token(params)
+      base_url = plasticine_url(id: params[:id])
+      authentificator = Plasticine::Authentication.new(base_url, params)
+      authentificator.tokenize
+    end
+
+    def t(path)
+      Plasticine.translate(path)
+    end
+
+    def visual(nature, options={})
+      options.reverse_merge! class: "", data: {}
+
+      options[:class] += " plasticine plasticine-#{nature}"
+
+      build_url nature, options
+
+      options[:data][:visual] = nature
+      options[:data][:url] = @url
+      options[:data][:update_delay] = options[:update_every].to_i if options[:update_every]
+
+      content = content_tag(:div, '', id: @id, class: options[:class], data: options[:data])
+      content << link_to(@url, @url)
+
+      content
+    end
+  end
+
+  ::ActionView::Base.send :include, self
+end

data/lib/plasticine/railtie.rb

@@ -0,0 +1,15 @@
+module Plasticine
+  class Railtie < Rails::Railtie
+    initializer "plasticine" do |app|
+      ActiveSupport.on_load :action_view do
+        require 'plasticine/helpers'
+      end
+    end
+  end
+end
+
+dir = File.expand_path(File.dirname(__FILE__))
+languages = [:fr, :en]
+
+I18n.load_path += languages.map { |l| File.join(dir, '../../config/locales', "#{l}.yml") }
+

data/plasticine.gemspec

@@ -0,0 +1,22 @@
+Gem::Specification.new do |gem|
+  gem.name        = "plasticine"
+  gem.description = "Data visualization toolkit for Rails App using D3.js"
+  gem.summary     = "Data visualization toolkit for Rails App using D3.js"
+  gem.homepage    = "https://github.com/alchimikweb/plasticine"
+  gem.version     = "1.1.0"
+  gem.licenses    = ["MIT"]
+
+  gem.authors     = ["Sebastien Rosa"]
+  gem.email       = ["sebastien@alchimik.com"]
+
+  gem.files       = `git ls-files`.split($\)
+  gem.executables = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files  = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "rails", ['~> 5.0']
+  gem.add_development_dependency "sqlite3", "~> 1.3"
+  gem.add_development_dependency "rspec-rails", "~> 3.7"
+  gem.add_development_dependency "simplecov", "~> 0.15"
+  gem.add_development_dependency "simplecov-rcov-text", "~> 0"
+end

data/spec/controllers/application_controller_spec.rb

@@ -0,0 +1,18 @@
+require "spec_helper"
+
+describe ApplicationController, type: :controller do
+  controller do
+    def index
+      render plain: 'Done'
+    end
+  end
+
+  describe "when calling index action" do
+    it 'should be done' do
+      get :index
+
+      expect(response.status).to eq(200)
+      expect(response.body).to eq "Done"
+    end
+  end
+end

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks