dashing-rails 1.0.3 → 2.0.0

data/.gitignore

@@ -0,0 +1,10 @@
+.bundle/
+log/*.log
+pkg/
+spec/dummy/db/*.sqlite3
+spec/dummy/db/*.sqlite3-journal
+spec/dummy/log/*.log
+spec/dummy/tmp/
+spec/dummy/.sass-cache
+.coveralls.yml
+coverage/

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+bundler_args: --without development
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0

data/CHANGELOG.md

@@ -0,0 +1,22 @@
+## 2.0.0
+
+* Refactor assets management. Now they all live in `vendor` directory.
+* Introduce a widget generator to build custom widget in a few seconds (`rails g dashing:widget my_widget`).
+* Rename configuration attributes (you need to regenerate the initializer config file with `rails g dashing:install`)
+* Simplify widget view path
+* Bug fixes
+
+## 1.0.3
+
+* cherrypick https://github.com/Shopify/dashing/pull/253
+* cherrypick https://github.com/Shopify/dashing/commit/2b715ac63dd2de5c718142822663dbded44bbecd
+* cherrypick https://github.com/Shopify/dashing/commit/9f93895bd40aad02e88f7ed7bfd954c930aa27db
+* cherrypick https://github.com/Shopify/dashing/commit/9496b31d7787182b561bd99f8674901bd7667976
+* cherrypick https://github.com/Shopify/dashing/pull/181
+* cherrypick https://github.com/Shopify/dashing/commit/3af326da84251069c4e6f7464d0ae8506b20e98b
+* cherrypick https://github.com/Shopify/dashing/pull/211
+
+## 1.0.2
+
+* Fix redis connection. Now using connection pool
+* Allow redis custom connection using custom redis host, port and password.

data/Gemfile

@@ -0,0 +1,21 @@
+source 'https://rubygems.org'
+
+# Declare your gem's dependencies in dashing.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+gem 'sqlite3'
+gem 'jquery-rails', '~> 3.0'
+
+group :test do
+  gem 'coveralls',  require: false
+  gem 'simplecov',  require: false
+  gem 'rspec-rails', '~> 2.14'
+  gem 'pry-rails',   '~> 0.3'
+end

data/Gemfile.lock

@@ -0,0 +1,150 @@
+PATH
+  remote: .
+  specs:
+    dashing-rails (2.0.0)
+      coffee-script (~> 2.2)
+      connection_pool (~> 1.1)
+      jquery-rails (~> 3.0)
+      rails (~> 4.0.0)
+      redis (~> 3.0)
+      rufus-scheduler (~> 3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (4.0.0)
+      actionpack (= 4.0.0)
+      mail (~> 2.5.3)
+    actionpack (4.0.0)
+      activesupport (= 4.0.0)
+      builder (~> 3.1.0)
+      erubis (~> 2.7.0)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    activemodel (4.0.0)
+      activesupport (= 4.0.0)
+      builder (~> 3.1.0)
+    activerecord (4.0.0)
+      activemodel (= 4.0.0)
+      activerecord-deprecated_finders (~> 1.0.2)
+      activesupport (= 4.0.0)
+      arel (~> 4.0.0)
+    activerecord-deprecated_finders (1.0.3)
+    activesupport (4.0.0)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    arel (4.0.1)
+    atomic (1.1.12)
+    better_errors (1.0.1)
+      coderay (>= 1.0.0)
+      erubis (>= 2.6.6)
+    builder (3.1.4)
+    coderay (1.0.9)
+    coffee-script (2.2.0)
+      coffee-script-source
+      execjs
+    coffee-script-source (1.6.3)
+    connection_pool (1.1.0)
+    coveralls (0.7.0)
+      multi_json (~> 1.3)
+      rest-client
+      simplecov (>= 0.7)
+      term-ansicolor
+      thor
+    diff-lcs (1.2.4)
+    erubis (2.7.0)
+    execjs (2.0.2)
+    hike (1.2.3)
+    i18n (0.6.4)
+    jquery-rails (3.0.4)
+      railties (>= 3.0, < 5.0)
+      thor (>= 0.14, < 2.0)
+    mail (2.5.4)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    method_source (0.8.2)
+    mime-types (1.25)
+    minitest (4.7.5)
+    multi_json (1.7.7)
+    polyglot (0.3.3)
+    pry (0.9.12.2)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    pry-rails (0.3.2)
+      pry (>= 0.9.10)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (4.0.0)
+      actionmailer (= 4.0.0)
+      actionpack (= 4.0.0)
+      activerecord (= 4.0.0)
+      activesupport (= 4.0.0)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.0.0)
+      sprockets-rails (~> 2.0.0)
+    railties (4.0.0)
+      actionpack (= 4.0.0)
+      activesupport (= 4.0.0)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.1.0)
+    redis (3.0.5)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    rspec-core (2.14.4)
+    rspec-expectations (2.14.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.1)
+    rspec-rails (2.14.0)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rufus-scheduler (3.0.2)
+      tzinfo
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+    slop (3.4.6)
+    sprockets (2.10.0)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sprockets-rails (2.0.1)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (~> 2.8)
+    sqlite3 (1.3.7)
+    term-ansicolor (1.2.2)
+      tins (~> 0.8)
+    thor (0.18.1)
+    thread_safe (0.1.2)
+      atomic
+    tilt (1.4.1)
+    tins (0.12.0)
+    treetop (1.4.15)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.37)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  better_errors (~> 1.0)
+  coveralls
+  dashing-rails!
+  jquery-rails (~> 3.0)
+  pry-rails (~> 0.3)
+  rspec-rails (~> 2.14)
+  simplecov
+  sqlite3

data/README.md

@@ -7,6 +7,8 @@
 Dashing-rails is the Rails Engine version of [Dashing by Shopify](http://shopify.github.io/dashing/).
 A huge thanks to Shopify for their great work with the Sinatra version.
 
+**Warning**: To upgrade from `1.x.x` to `2.x.x` you need to run `rails g dashing:install`. Please read `CHANGELOG.md` for more details.
+
 ## Introduction
 
 Dashing is a Rails engine that lets you build beautiful dashboards.
@@ -33,11 +35,11 @@ Key features:
 
 1. Install the gem by adding the following in your `Gemfile`:
 
-		gem 'dashing-rails'
+        gem 'dashing-rails'
 
 2. Install puma server by adding the following in your `Gemfile`:
 
-		gem 'puma'
+    	gem 'puma'
 
 3. Bundle install
 
@@ -47,17 +49,17 @@ Key features:
 
 		$ rails g dashing:install
 
-5. Restart your server (must be a multi threaded server - See [Requirements](https://github.com/gottfrois/dashing-rails#requirements))
+5. Start redis server:
 
-		$ puma
+    	$ redis-server
 
-6. Start redis server:
+6. Open `config/development.rb` and add:
 
-		$ redis-server
+		config.allow_concurrency = true
 
-7. Open `config/development.rb` and add:
+7. Start your server (must be a multi threaded server - See [Requirements](https://github.com/gottfrois/dashing-rails#requirements))
 
-		config.allow_concurrency = true
+    	$ rails s
 
 8. Point your browser at [http://0.0.0.0:9292/dashing/dashboards](http://0.0.0.0:9292/dashing/dashboards) and have fun!
 
@@ -70,7 +72,8 @@ Every new Dashing project comes with sample widgets & sample dashboards for you
 
 * `app/views/dashing/dashboards` — One .erb file for each dashboard that contains the layout for the widgets.
 * `app/jobs` — Your ruby jobs for fetching data (e.g for calling third party APIs like twitter).
-* `app/views/dashing/widgets` — All the html/css/coffee for individual widgets.
+* `app/assets/javascripts/dashing/widgets/` — One folder with widget's name containing a JS file.
+* `app/assets/stylesheets/dashing/widgets/` — One folder with widget's name containing a CSS file.
 * `app/views/layouts/dashing/` — All your custom layouts where your dashboards and widgets will be included.
 
 ## Getting Data Into Your Widgets
@@ -84,11 +87,11 @@ Dashing uses [rufus-scheduler](http://rufus.rubyforge.org/rufus-scheduler/) to s
 Example:
 
 	# :first_in sets how long it takes before the job is first run. In this case, it is run immediately
-	Dashing.scheduler.every '1m', :first_in => 0 do |job|
+	Dashing.scheduler.every '1m', first_in: 0 do |job|
 	  Dashing.send_event('karma', { current: rand(1000) })
 	end
 
-This job will run every minute, and will send a random number to ALL widgets that have `data-id` set to 'karma'.
+This job will run every minute, and will send a random number to ALL widgets that have `data-id` set to `"karma"`.
 
 You send data using the following method:
 
@@ -130,87 +133,56 @@ Your widgets can be updated directly over HTTP. Post the data you want in json t
 
 Example:
 
-	curl -d '{ "auth_token": "YOUR_AUTH_TOKEN", "current": 100 }' http://0.0.0.0:9292/dashing/widgets/karma
+	curl -d '{ "auth_token": "YOUR_AUTH_TOKEN", "current": 100 }' http://locahost:3000/dashing/widgets/karma
 
 or
 
-	HTTParty.post('http://0.0.0.0:9292/dashing/widgets/karma',
+	HTTParty.post('http://locahost:3000/dashing/widgets/karma',
 	  body: { auth_token: "YOUR_AUTH_TOKEN", current: 1000 }.to_json)
 
 #### Dasboards
 
 The `reload` action provided by [Shopify Dashing](http://shopify.github.io/dashing/) is currently not available.
 
-## Additional Resources
-
-Check out the [wiki](https://github.com/gottfrois/dashing-rails/wiki) for interesting tips such as hosting on Heroku, or adding authentication.
-
-For more information on Dashboards and Widgets HTML/CSS/JS, please read [Shopify Dashing documentation](http://shopify.github.io/dashing).
-
-Be sure to look at the [list of third party widgets](https://github.com/Shopify/dashing/wiki/Additional-Widgets).
-
-## Browser Compatibility
+## Create a new Widget
 
-Tested in Chrome, Safari 6+, and Firefox 15+.
+In order to create or add a custom widget to dashing-rails, simply follow the following steps:
 
-Does not work in Internet Explorer because it relies on [Server Sent Events](http://www.html5rocks.com/en/tutorials/eventsource/basics/).
+1. Run
 
-## Heroku
+        $ rails g dashing:widget my_widget
 
-Setting Dashing-rails on Heroku is pretty simple:
+2. Edit `app/views/dashing/widgets/my_widget.html`
 
-1. Create a new app:
+3. Edit `app/assets/javascripts/dashing/widgets/my_widget.coffee`
 
-		heroku apps:create example
-		
-2. Add [RedisToGo](https://devcenter.heroku.com/articles/redistogo) addon to heroku's app:
+4. Edit `app/assets/stylesheets/dashing/widgets/my_widget.scss`
 
-		heroku addons:add redistogo
-		
-3. Add [PostgresSQL](https://devcenter.heroku.com/articles/heroku-postgresql) addon to heroku's app (this is up to you):
+You can also install pre-package widget compatible with dashing-rails. Here is [a list of all Dashing-Rails compatible Widgets](https://github.com/gottfrois/dashing-rails/wiki).
 
-		heroku addons:add heroku-postgresql:dev
-		
-4. Add `puma` to your `Gemfile`:
+*Note: the paths may be different depending on your dashing-rails configuration. Check your `config/initializers/dashing.rb` file.*
 
-		gem 'puma'
-		
-5. Create a new `Procfile` for you application:
+## Additional Resources
 
-		web: bundle exec puma -p $PORT -e $RACK_ENV -t 0:5
+Check out the [wiki](https://github.com/gottfrois/dashing-rails/wiki) for interesting tips such as hosting on Heroku, adding authentication or adding custom widgets.
 
-6. Tell Dashing-rails how to you the Heroku's redis connection by setting redis credentials in `config/initializers/dashing.rb`:
+## Browser Compatibility
 
-		config.redis_host     = URI.parse(ENV["REDISTOGO_URL"]).host
-		config.redis_port     = URI.parse(ENV["REDISTOGO_URL"]).port
-		config.redis_password = URI.parse(ENV["REDISTOGO_URL"]).password
-		
-7. Commit and Push to heroku:
+Tested in Chrome, Safari 6+, and Firefox 15+.
 
-		git commit -m "configure dashing to work on heroku"
-		git push heroku master
-	
-8. That's it! Visit [http://your_app.herokuapp.com/dashing/dashboards](http://dashing-rails-demo.herokuapp.com/dashing/dashboards)
-		
-You can checkout the following application on [Github](https://github.com/gottfrois/dashing-rails-demo) running on [Heroku](http://dashing-rails-demo.herokuapp.com/dashing/dashboards)
-		
-*`puma -t 0:5` lets you configure the number of threads you want puma to run on.*
+Does not work in Internet Explorer because it relies on [Server Sent Events](http://www.html5rocks.com/en/tutorials/eventsource/basics/).
 
 ## Contributors
 
-[Shopify Dashing official page](http://shopify.github.io/dashing/)
-
-[Dashing-rails contributors](https://github.com/gottfrois/dashing-rails/contributors)
-
-[Shopify Dashing contributors](https://github.com/Shopify/dashing/graphs/contributors)
+* [Shopify Dashing official page](http://shopify.github.io/dashing/)
+* [Dashing-rails contributors](https://github.com/gottfrois/dashing-rails/contributors)
+* [Shopify Dashing contributors](https://github.com/Shopify/dashing/graphs/contributors)
 
 All contributions are more than welcome; especially new widgets!
 
 Please add spec to your Pull Requests and run them using:
 
-	rake
-
-You can use the following [demo application](https://github.com/gottfrois/dashing-rails-demo) to test dashing-rails in development.
+	$ rake
 
 ## License
 

data/app/assets/javascripts/dashing/application.js

@@ -10,18 +10,7 @@
 // WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
 // GO AFTER THE REQUIRES BELOW.
 //
-//= require jquery
-//= require jquery.gridster
-//= require jquery.knob
-//= require jquery.leanModal.min
-//= require jquery.timeago
-//= require moment.min
-//= require rickshaw-1.4.3.min
-//= require batman
-//= require batman.jquery
-//= require d3-3.2.8.min
-//= require es5-shim
+//= require dashing
 //= require_tree .
 //= require dashing.gridster
-//= require default_widgets
 //= require widgets

data/app/assets/stylesheets/dashing/application.css

@@ -8,10 +8,6 @@
  * 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 font-awesome
- *= require jquery.gridster
- *= require default_widgets
- *= require widgets
- *= require_self
+ *= require dashing
  *= require_tree .
  */

data/app/controllers/dashing/dashboards_controller.rb

@@ -6,11 +6,11 @@ module Dashing
     rescue_from ActionView::MissingTemplate, with: :template_not_found
 
     def index
-      render file: dashboard_path(Dashing.config.default_dashboard || Dashing.first_dashboard || ''), layout: Dashing.config.dashboard_layout
+      render file: dashboard_path(Dashing.config.default_dashboard || Dashing.first_dashboard || ''), layout: Dashing.config.dashboard_layout_path
     end
 
     def show
-      render file: dashboard_path(params[:name]), layout: Dashing.config.dashboard_layout
+      render file: dashboard_path(params[:name]), layout: Dashing.config.dashboard_layout_path
     end
 
     private
@@ -20,7 +20,7 @@ module Dashing
     end
 
     def dashboard_path(name)
-      Rails.root.join(Dashing.config.dashboards_path, name)
+      Rails.root.join(Dashing.config.dashboards_views_path, name)
     end
 
     def template_not_found