dashing-rails 1.0.0

data/lib/assets/stylesheets/jquery.gridster.css

@@ -0,0 +1,57 @@
+/*! gridster.js - v0.1.0 - 2012-08-14
+* http://gridster.net/
+* Copyright (c) 2012 ducksboard; Licensed MIT */
+
+.gridster {
+    position:relative;
+}
+
+.gridster > * {
+    margin: 0 auto;
+    -webkit-transition: height .4s;
+    -moz-transition: height .4s;
+    -o-transition: height .4s;
+    -ms-transition: height .4s;
+    transition: height .4s;
+}
+
+.gridster .gs_w{
+    z-index: 2;
+    position: absolute;
+}
+
+.ready .gs_w:not(.preview-holder) {
+    -webkit-transition: opacity .3s, left .3s, top .3s;
+    -moz-transition: opacity .3s, left .3s, top .3s;
+    -o-transition: opacity .3s, left .3s, top .3s;
+    transition: opacity .3s, left .3s, top .3s;
+}
+
+.gridster .preview-holder {
+    z-index: 1;
+    position: absolute;
+    background-color: #fff;
+    border-color: #fff;
+    opacity: 0.3;
+}
+
+.gridster .player-revert {
+    z-index: 10!important;
+    -webkit-transition: left .3s, top .3s!important;
+    -moz-transition: left .3s, top .3s!important;
+    -o-transition: left .3s, top .3s!important;
+    transition:  left .3s, top .3s!important;
+}
+
+.gridster .dragging {
+    z-index: 10!important;
+    -webkit-transition: all 0s !important;
+    -moz-transition: all 0s !important;
+    -o-transition: all 0s !important;
+    transition: all 0s !important;
+}
+
+/* Uncomment this if you set helper : "clone" in draggable options */
+/*.gridster .player {
+  opacity:0;
+}*/

data/lib/dashing.rb

@@ -0,0 +1,29 @@
+module Dashing
+  class << self
+
+    delegate :scheduler, :redis, to: :config
+
+    attr_accessor :configuration
+
+    def config
+      self.configuration ||= Configuration.new
+    end
+
+    def configure
+      yield config
+    end
+
+    def first_dashboard
+      files = Dir[Rails.root.join(config.dashboards_path, '*')].collect { |f| File.basename(f, '.*') }
+      files.sort.first
+    end
+
+    def send_event(id, data)
+      redis.publish("#{Dashing.config.redis_namespace}.create", data.merge(id: id, updatedAt: Time.now.utc.to_i).to_json)
+    end
+
+  end
+end
+
+require 'dashing/configuration'
+require 'dashing/engine'

data/lib/dashing/configuration.rb

@@ -0,0 +1,26 @@
+require 'rufus-scheduler'
+require 'redis'
+
+module Dashing
+  class Configuration
+
+    attr_accessor :scheduler, :redis, :view_path, :jobs_path, :redis_namespace,
+                  :engine_path, :dashboards_path, :dashboard_layout,
+                  :widgets_path, :default_dashboard, :auth_token
+
+    def initialize
+      @scheduler          = ::Rufus::Scheduler.new
+      @redis              = ::Redis.new
+      @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
+      @auth_token         = nil
+    end
+
+  end
+end

data/lib/dashing/engine.rb

@@ -0,0 +1,13 @@
+module Dashing
+  class Engine < ::Rails::Engine
+    isolate_namespace Dashing
+
+    config.assets.paths << Dashing::Engine.root.join('app', 'assets', 'fonts')
+    config.assets.paths << Dashing::Engine.root.join('app', 'views', 'dashing')
+    config.assets.paths << Dashing.config.view_path
+
+    initializer 'require dashing jobs' do
+      Dir[Rails.root.join(Dashing.config.jobs_path, '**', '*.rb')].each { |file| require file }
+    end
+  end
+end

data/lib/dashing/version.rb

@@ -0,0 +1,3 @@
+module Dashing
+  VERSION = "1.0.0"
+end

data/lib/generators/dashing/install_generator.rb

@@ -0,0 +1,32 @@
+module Dashing
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+
+      source_root File.expand_path('../../templates', __FILE__)
+
+      desc 'Creates a Dashing initializer for your application.'
+
+      def install
+        route 'mount Dashing::Engine, at: Dashing.config.engine_path'
+      end
+
+      def copy_initializer
+        template 'initializer.rb', 'config/initializers/dashing.rb'
+      end
+
+      def copy_dashboard
+        template 'dashboards/sample.html.erb', 'app/views/dashing/dashboards/sample.html.erb'
+      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'
+      end
+
+      def copy_job
+        template 'jobs/sample.rb', 'app/jobs/sample.rb'
+      end
+
+    end
+  end
+end

data/lib/generators/dashing/job_generator.rb

@@ -0,0 +1,15 @@
+module Dashing
+  module Generators
+    class JobGenerator < ::Rails::Generators::NamedBase
+
+      source_root File.expand_path('../../templates', __FILE__)
+
+      desc 'Creates a new Dashing job.'
+
+      def job
+        template 'jobs/new.rb', "app/jobs/#{file_name}.rb"
+      end
+
+    end
+  end
+end

data/lib/generators/templates/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 -d '{ "auth_token": "YOUR_AUTH_TOKEN", "text": "Hey, Look what I can do!" }' \http://<%%= request.host %>:<%%= request.port %>/widgets/welcome</div></center>
+</div>

data/lib/generators/templates/initializer.rb

@@ -0,0 +1,50 @@
+# Use this hook to configure Dashing bahaviors.
+Dashing.configure do |config|
+  # Scheduler instance.
+  # config.scheduler = ::Rufus::Scheduler.new
+
+  # Redis instance.
+  # config.redis = ::Redis.new
+
+  # 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 creating a new folder at the following
+  # path by default: `/app/views/dashing/`
+  #
+  # 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
+  #
+  # 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/'
+
+  # 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 path used to find dashboards.
+  # config.dashboards_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/'
+
+  # 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
+end

data/lib/generators/templates/jobs/new.rb

@@ -0,0 +1,3 @@
+Dashing.scheduler.every '1s' do
+  Dashing.send_event('widget_id', { value: rand(100) })
+end

data/lib/generators/templates/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/lib/generators/templates/widgets/index.css

@@ -0,0 +1,12 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ */

data/lib/generators/templates/widgets/index.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require_tree .

data/lib/tasks/dashing_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :dashing do
+#   # Task goes here
+# end

data/spec/controllers/dashing/dashboards_controller_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe Dashing::DashboardsController do
+
+  describe 'GET "index"' do
+
+    def action
+      get :index, use_route: :dashing
+    end
+
+    it 'responds success' do
+      action
+      expect(response).to be_success
+    end
+
+  end
+
+  describe 'GET "show"' do
+
+    def action(params = {})
+      get :show, params.merge(use_route: :dashing)
+    end
+
+    context 'when template exists' do
+
+      it 'responds success' do
+        action(name: 'foo')
+        expect(response).to be_success
+      end
+
+    end
+
+    context 'when template does not exist' do
+
+      it { expect { action }.to raise_error }
+      it { expect { action(name: 'bar') }.to raise_error }
+
+    end
+
+  end
+
+end

data/spec/controllers/dashing/events_controller_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe Dashing::EventsController do
+
+  describe 'GET "index"' do
+
+    pending 'Require multithreads spec'
+
+  end
+
+end

data/spec/controllers/dashing/widgets_controller_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+describe Dashing::WidgetsController do
+
+  describe 'GET "show"' do
+
+    def action(params = {})
+      get :show, params.merge(use_route: :dashing)
+    end
+
+    context 'when default template exists' do
+
+      it 'responds success' do
+        action(name: 'text')
+        expect(response).to be_success
+      end
+
+    end
+
+    context 'when template exists in main app' do
+
+      it 'responds success' do
+        action(name: 'foo')
+        expect(response).to be_success
+      end
+
+    end
+
+    context 'when template does not exist' do
+
+      it { expect { action }.to raise_error }
+      it { expect { action(name: 'bar') }.to raise_error }
+
+    end
+
+  end
+
+  describe 'PUT "update"' do
+
+    def action(params = {})
+      put :update, params.merge(use_route: :dashing)
+    end
+
+    context 'when valid' do
+
+      it 'responds success' do
+        action(name: 'foo')
+        expect(response).to be_success
+      end
+
+    end
+
+    context 'when not valid' do
+
+      it { expect { action }.to raise_error }
+
+    end
+
+  end
+
+end

data/spec/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.