dashing-rails 1.0.3 → 2.0.0

data/app/controllers/dashing/widgets_controller.rb

@@ -26,20 +26,15 @@ module Dashing
     end
 
     def withdet_path
-      "#{params[:name]}/#{params[:name]}"
+      params[:name]
     end
 
     def prepend_view_paths
-      prepend_view_path engine_view_path
       prepend_view_path main_app_view_path
     end
 
-    def engine_view_path
-      Dashing::Engine.root.join('app', 'views', 'dashing', 'default_widgets')
-    end
-
     def main_app_view_path
-      Rails.root.join(Dashing.config.widgets_path)
+      Rails.root.join(Dashing.config.widgets_views_path)
     end
 
     def template_not_found

data/bin/rails

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 4 gems installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/dashing/engine', __FILE__)
+
+require 'rails/all'
+require 'rails/engine/commands'

data/dashing.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dashing/version'
+
+Gem::Specification.new do |spec|
+  spec.name         = 'dashing-rails'
+  spec.version      = Dashing::VERSION
+  spec.authors      = ['Pierre-Louis Gottfrois']
+  spec.email        = ['pierrelouis.gottfrois@gmail.com']
+  spec.description  = 'The exceptionally handsome dashboard framework for Rails.'
+  spec.summary      = 'The exceptionally handsome dashboard framework for Rails.'
+  spec.homepage     = 'https://github.com/gottfrois/dashing-rails'
+  spec.license      = 'MIT'
+
+  spec.files        = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'rails',                     '~> 4.0.0'
+  spec.add_dependency 'jquery-rails',              '~> 3.0'
+  spec.add_dependency 'coffee-script',             '~> 2.2'
+  spec.add_dependency 'rufus-scheduler',           '~> 3.0'
+  spec.add_dependency 'redis',                     '~> 3.0'
+  spec.add_dependency 'connection_pool',           '~> 1.1'
+
+  spec.add_development_dependency 'rspec-rails',   '~> 2.14'
+  spec.add_development_dependency 'pry-rails',     '~> 0.3'
+  spec.add_development_dependency 'better_errors', '~> 1.0'
+end

data/lib/dashing.rb

@@ -14,7 +14,7 @@ module Dashing
     end
 
     def first_dashboard
-      files = Dir[Rails.root.join(config.dashboards_path, '*')].collect { |f| File.basename(f, '.*') }
+      files = Dir[Rails.root.join(config.dashboards_views_path, '*')].collect { |f| File.basename(f, '.*') }
       files.sort.first
     end
 

data/lib/dashing/configuration.rb

@@ -6,30 +6,47 @@ module Dashing
   class Configuration
 
     attr_reader   :redis
-    attr_accessor :scheduler, :view_path, :jobs_path, :redis_namespace,
-                  :engine_path, :dashboards_path, :dashboard_layout,
-                  :widgets_path, :default_dashboard, :auth_token, :devise_allowed_models,
-                  :redis_host, :redis_port, :redis_password
+    attr_accessor :redis_host, :redis_port, :redis_password, :redis_namespace
+    attr_accessor :auth_token, :devise_allowed_models
+    attr_accessor :jobs_path
+    attr_accessor :default_dashboard, :dashboards_views_path, :dashboard_layout_path
+    attr_accessor :widgets_views_path, :widgets_js_path, :widgets_css_path
+    attr_accessor :engine_path, :scheduler
 
     def initialize
+      @engine_path            = '/dashing'
       @scheduler              = ::Rufus::Scheduler.new
+
+      # Redis
       @redis_host             = '127.0.0.1'
       @redis_port             = '6379'
       @redis_password         = nil
       @redis_namespace        = 'dashing_events'
-      @view_path              = 'app/views/dashing/'
-      @jobs_path              = 'app/jobs/'
-      @engine_path            = '/dashing'
-      @dashboards_path        = 'app/views/dashing/dashboards/'
-      @dashboard_layout       = 'dashing/dashboard'
-      @widgets_path           = 'app/views/dashing/widgets/'
-      @default_dashboard      = nil
+
+      # Authorization
       @auth_token             = nil
       @devise_allowed_models  = []
+
+      # Jobs
+      @jobs_path              = 'app/jobs/'
+
+      # Dashboards
+      @default_dashboard      = nil
+      @dashboards_views_path  = 'app/views/dashing/dashboards/'
+      @dashboard_layout_path  = 'dashing/dashboard'
+
+      # Widgets
+      @widgets_views_path     = 'app/views/dashing/widgets/'
+      @widgets_js_path        = 'app/assets/javascripts/dashing'
+      @widgets_css_path       = 'app/assets/stylesheets/dashing'
     end
 
     def redis
-      @redis ||= ::ConnectionPool::Wrapper.new(size: request_thread_count, timeout: 3) { ::Redis.new(host: redis_host, port: redis_port, password: redis_password) }
+      @redis ||= ::ConnectionPool::Wrapper.new(size: request_thread_count, timeout: 3) { new_redis_connection }
+    end
+
+    def new_redis_connection
+      ::Redis.new(host: redis_host, port: redis_port, password: redis_password)
     end
 
     private

data/lib/dashing/engine.rb

@@ -2,9 +2,13 @@ module Dashing
   class Engine < ::Rails::Engine
     isolate_namespace Dashing
 
-    config.assets.paths << Dashing::Engine.root.join('app', 'assets', 'fonts', 'dashing')
-    config.assets.paths << Dashing::Engine.root.join('app', 'views', 'dashing')
-    config.assets.paths << Dashing.config.view_path
+    config.assets.paths.unshift       Dashing::Engine.root.join('vendor', 'assets', 'fonts', 'dashing')
+    config.assets.paths.unshift       Dashing::Engine.root.join('vendor', 'assets', 'javascripts', 'dashing')
+    config.assets.paths.unshift       Dashing::Engine.root.join('vendor', 'assets', 'stylesheets', 'dashing')
+    config.assets.paths.unshift       Dashing.config.widgets_js_path
+    config.assets.paths.unshift       Dashing.config.widgets_css_path
+
+    config.paths['app/views'].unshift Dashing::Engine.root.join('app', 'views', 'dashing', 'widgets')
 
     initializer 'require dashing jobs' do
       Dir[Rails.root.join(Dashing.config.jobs_path, '**', '*.rb')].each { |file| require file }

data/lib/dashing/version.rb

@@ -1,3 +1,3 @@
 module Dashing
-  VERSION = "1.0.3"
+  VERSION = '2.0.0'
 end

data/lib/generators/dashing/install_generator.rb

@@ -19,8 +19,8 @@ module Dashing
       end
 
       def copy_widget_manifests
-        template 'widgets/index.css', 'app/views/dashing/widgets/index.css'
-        template 'widgets/index.js', 'app/views/dashing/widgets/index.js'
+        template 'widgets/index.css', 'app/assets/stylesheets/dashing/widgets/index.css'
+        template 'widgets/index.js', 'app/assets/javascripts/dashing/widgets/index.js'
       end
 
       def copy_job

data/lib/generators/dashing/widget_generator.rb

@@ -0,0 +1,17 @@
+module Dashing
+  module Generators
+    class WidgetGenerator < ::Rails::Generators::NamedBase
+
+      source_root File.expand_path('../../templates', __FILE__)
+
+      desc 'Creates a new Dashing widget.'
+
+      def widget
+        template 'widgets/new.html',    "#{Dashing.config.widgets_views_path}#{file_name}.html"
+        template 'widgets/new.scss',    "#{Dashing.config.widgets_css_path}/widgets/#{file_name}.scss"
+        template 'widgets/new.coffee',  "#{Dashing.config.widgets_js_path}/widgets/#{file_name}.coffee"
+      end
+
+    end
+  end
+end

data/lib/generators/templates/dashboards/sample.html.erb

@@ -24,5 +24,5 @@
       <div data-id="convergence" data-view="Graph" data-title="Convergence" style="background-color:#ff9618"></div>
     </li>
   </ul>
-  <center><div style="font-size: 12px">Try this: curl -d '{ "auth_token": "YOUR_AUTH_TOKEN", "text": "Hey, Look what I can do!" }' \http://<%%= request.host %>:<%%= request.port %>/widgets/welcome</div></center>
+  <center><div style="font-size: 12px">Try this: curl -X PUT 'http://<%%= request.host %>:<%%= request.port %>/dashing/widgets/welcome' --data "widget%5Btext%5D=Dashing+is+awesomecurl"</div></center>
 </div>

data/lib/generators/templates/initializer.rb

@@ -13,18 +13,22 @@ Dashing.configure do |config|
   # config.redis_namespace = 'dashing_events'
 
   # Dashing come with default widgets using css and coffeescript.
-  # You can create your own widgets by creating a new folder at the following
-  # path by default: `/app/views/dashing/`
+  # You can create your own widgets by adding the following files:
   #
-  # A widget folder is composed of:
-  # - an HTML file used for layout and bindings
-  # - a SCSS file for styles
-  # - a coffeescript file which allows you to handle incoming data & functionality
+  # A widget is composed of:
+  # - an HTML file used for layout and bindings                                     - app/views/dashing/widgets/foo.html
+  # - a SCSS file for styles                                                        - app/assets/stylesheets/dashing/widgets/foo.scss
+  # - a coffeescript file which allows you to handle incoming data & functionality  - app/assets/javascripts/dashing/widgets/foo.coffee
   #
   # CSS and JS file will be added to the asset path and the asset pipeline automatically.
   #
   # More information at http://shopify.github.io/dashing/
-  # config.view_path = 'app/views/dashing/'
+  #
+  # You can change default views and assets paths with the following config:
+  #
+  # config.widgets_views_path = 'app/views/dashing/widgets/'
+  # config.widgets_js_path    = 'app/assets/javascripts/dashing'
+  # config.widgets_css_path   = 'app/assets/stylesheets/dashing'
 
   # rufus-scheduler worker path
   # config.jobs_path = 'app/jobs/'
@@ -33,15 +37,11 @@ Dashing.configure do |config|
   # Ex: http://your_app/dashing/dashboard/my_dashboard_name
   # config.engine_path = '/dashing'
 
-  # The dashboards path used to find dashboards.
-  # config.dashboards_path = 'app/views/dashing/dashboards/'
+  # The dashboards views path used to find dashboards.
+  # config.dashboards_views_path = 'app/views/dashing/dashboards/'
 
   # The Dashing layout used to display metrics.
-  # config.dashboard_layout = 'dashing/dashboard'
-
-  # The widgets path used to find your custom widgets.
-  # Dashing provide default widgets.
-  # config.widgets_path = 'app/views/dashing/widgets/'
+  # config.dashboard_layout_path = 'dashing/dashboard'
 
   # Default dashboard name to load when going to /dashing/dashboards
   # config.default_dashboard = nil
@@ -52,6 +52,6 @@ Dashing.configure do |config|
   # config.auth_token = nil
 
   # List of Devise models that should access the whole dashboard.
-  # List the models. E.g: '[ :user, :admin ]'
+  # List the models. E.g: '[:user, :admin]'
   # config.devise_allowed_models = []
 end

data/lib/generators/templates/widgets/new.coffee

@@ -0,0 +1,9 @@
+class Dashing.<%= class_name.capitalize %> extends Dashing.Widget
+
+  ready: ->
+    # This is fired when the widget is done being rendered
+
+  onData: (data) ->
+    # Handle incoming data
+    # You can access the html node of this widget with `@node`
+    # Example: $(@node).fadeOut().fadeIn() will make the node flash each time data comes in.

data/lib/generators/templates/widgets/new.html

@@ -0,0 +1 @@
+<!-- Your new widget html -->

data/lib/generators/templates/widgets/new.scss

@@ -0,0 +1,10 @@
+// ----------------------------------------------------------------------------
+// Sass declarations
+// ----------------------------------------------------------------------------
+
+// ----------------------------------------------------------------------------
+// Widget-<%= class_name.downcase %> styles
+// ----------------------------------------------------------------------------
+.widget-<%= class_name.downcase %> {
+
+}

data/spec/dummy/app/jobs/sample.rb

@@ -0,0 +1,9 @@
+current_valuation = 0
+
+Dashing.scheduler.every '2s' do
+  last_valuation = current_valuation
+  current_valuation = rand(100)
+
+  Dashing.send_event('valuation', { current: current_valuation, last: last_valuation })
+  Dashing.send_event('synergy',   { value: rand(100) })
+end

data/spec/dummy/app/views/dashing/dashboards/sample.html.erb

@@ -0,0 +1,28 @@
+<% content_for :title do %>
+  My super sweet dashboard
+<% end %>
+
+<div class="gridster">
+  <ul>
+    <li data-row="1" data-col="1" data-sizex="2" data-sizey="1">
+      <div data-id="welcome" data-view="Text" data-title="Hello" data-text="This is your shiny new dashboard." data-moreinfo="Protip: You can drag the widgets around!"></div>
+    </li>
+
+    <li data-row="1" data-col="1" data-sizex="1" data-sizey="1">
+      <div data-id="synergy" data-view="Meter" data-title="Synergy" data-min="0" data-max="100"></div>
+    </li>
+
+    <li data-row="1" data-col="1" data-sizex="1" data-sizey="2">
+      <div data-id="buzzwords" data-view="List" data-unordered="true" data-title="Buzzwords" data-moreinfo="# of times said around the office"></div>
+    </li>
+
+    <li data-row="1" data-col="1" data-sizex="1" data-sizey="1">
+      <div data-id="valuation" data-view="Number" data-title="Current Valuation" data-moreinfo="In billions" data-prefix="$"></div>
+    </li>
+
+    <li data-row="1" data-col="1" data-sizex="2" data-sizey="1">
+      <div data-id="convergence" data-view="Graph" data-title="Convergence" style="background-color:#ff9618"></div>
+    </li>
+  </ul>
+  <center><div style="font-size: 12px">Try this: curl -X PUT 'http://<%= request.host %>:<%= request.port %>/dashing/widgets/welcome' --data "widget%5Btext%5D=Dashing+is+awesomecurl"</div></center>
+</div>

data/spec/dummy/config/initializers/dashing.rb

@@ -0,0 +1,57 @@
+# Use this hook to configure Dashing bahaviors.
+Dashing.configure do |config|
+  # Scheduler instance.
+  # config.scheduler = ::Rufus::Scheduler.new
+
+  # Redis credentials.
+  # See https://devcenter.heroku.com/articles/redistogo to configure redis for heroku.
+  # config.redis_host     = '127.0.0.1'
+  # config.redis_port     = '6379'
+  # config.redis_password = nil
+
+  # Redis namespace when pushing new data.
+  # config.redis_namespace = 'dashing_events'
+
+  # Dashing come with default widgets using css and coffeescript.
+  # You can create your own widgets by adding the following files:
+  #
+  # A widget is composed of:
+  # - an HTML file used for layout and bindings                                     - app/views/dashing/widgets/foo.html
+  # - a SCSS file for styles                                                        - app/assets/stylesheets/dashing/widgets/foo.scss
+  # - a coffeescript file which allows you to handle incoming data & functionality  - app/assets/javascripts/dashing/widgets/foo.coffee
+  #
+  # CSS and JS file will be added to the asset path and the asset pipeline automatically.
+  #
+  # More information at http://shopify.github.io/dashing/
+  #
+  # You can change default views and assets paths with the following config:
+  #
+  # config.widgets_views_path = 'app/views/dashing/widgets/'
+  # config.widgets_js_path    = 'app/assets/javascripts/dashing'
+  # config.widgets_css_path   = 'app/assets/stylesheets/dashing'
+
+  # rufus-scheduler worker path
+  # config.jobs_path = 'app/jobs/'
+
+  # Engine path to use for accessing engine's routes.
+  # Ex: http://your_app/dashing/dashboard/my_dashboard_name
+  # config.engine_path = '/dashing'
+
+  # The dashboards views path used to find dashboards.
+  # config.dashboards_views_path = 'app/views/dashing/dashboards/'
+
+  # The Dashing layout used to display metrics.
+  # config.dashboard_layout_path = 'dashing/dashboard'
+
+  # Default dashboard name to load when going to /dashing/dashboards
+  # config.default_dashboard = nil
+
+  # A secure random string to authenticate with for curl requests.
+  # Put nil if you don't want to use authentication.
+  # You can use SecureRandom.hex to generate a hex.
+  # config.auth_token = nil
+
+  # List of Devise models that should access the whole dashboard.
+  # List the models. E.g: '[:user, :admin]'
+  # config.devise_allowed_models = []
+end

data/spec/dummy/config/routes.rb

@@ -1,4 +1,3 @@
 Rails.application.routes.draw do
-
-  mount Dashing::Engine => "/dashing"
+  mount Dashing::Engine, at: Dashing.config.engine_path
 end

data/spec/lib/dashing/configuration_spec.rb

@@ -4,22 +4,32 @@ describe Dashing::Configuration do
 
   let(:instance) { Dashing::Configuration.new }
 
-  it { expect(instance.scheduler).to              be_a(::Rufus::Scheduler) }
+  it { expect(instance.engine_path).to            eq('/dashing') }
+  # it { expect(instance.scheduler).to              be_a(::Rufus::Scheduler.new) }
+  it { expect(instance.redis).to                  be_a(::Redis) }
+
+  # Redis
   it { expect(instance.redis_host).to             eq('127.0.0.1') }
   it { expect(instance.redis_port).to             eq('6379') }
   it { expect(instance.redis_password).to         be_nil }
   it { expect(instance.redis_namespace).to        eq('dashing_events') }
-  it { expect(instance.view_path).to              eq('app/views/dashing/') }
-  it { expect(instance.jobs_path).to              eq('app/jobs/') }
-  it { expect(instance.engine_path).to            eq('/dashing') }
-  it { expect(instance.dashboards_path).to        eq('app/views/dashing/dashboards/') }
-  it { expect(instance.dashboard_layout).to       eq('dashing/dashboard') }
-  it { expect(instance.widgets_path).to           eq('app/views/dashing/widgets/') }
-  it { expect(instance.default_dashboard).to      be_nil }
+
+  # Authorization
   it { expect(instance.auth_token).to             be_nil }
   it { expect(instance.devise_allowed_models).to  be_empty }
 
-  it { expect(instance.redis).to                  be_a(::Redis) }
+  # Jobs
+  it { expect(instance.jobs_path).to              eq('app/jobs/') }
+
+  # Dashboards
+  it { expect(instance.default_dashboard).to      be_nil }
+  it { expect(instance.dashboards_views_path).to  eq('app/views/dashing/dashboards/') }
+  it { expect(instance.dashboard_layout_path).to  eq('dashing/dashboard') }
+
+  # Widgets
+  it { expect(instance.widgets_views_path).to     eq('app/views/dashing/widgets/') }
+  it { expect(instance.widgets_js_path).to        eq('app/assets/javascripts/dashing') }
+  it { expect(instance.widgets_css_path).to       eq('app/assets/stylesheets/dashing') }
 
   describe '#request_thread_count' do