Merge pull request #296 from Shopify/updating_gems_and_refactoring

Updating gems and refactoring

Author: pushmatrix

.gitignore

@@ -1,3 +1,5 @@
 *DS_STORE
 /Gemfile.lock
-*.gem
+*.gem
+coverage/
+.ruby-version

.travis.yml

@@ -1,6 +1,7 @@
 language: ruby
 rvm:
+  - 2.1.0
   - 2.0.0
   - 1.9.3
 
-script: "rake test"
+script: "rake test"

bin/dashing

@@ -1,112 +1,8 @@
 #!/usr/bin/env ruby
+require "pathname"
+bin_file = Pathname.new(__FILE__).realpath
+$:.unshift File.expand_path("../../lib", bin_file)
 
-require 'thor'
-require 'net/http'
-require 'json'
-require 'open-uri'
-
-class MockScheduler
-  def method_missing(*args)
-    yield
-  end
-end
-
-SCHEDULER = MockScheduler.new
-
-module Dashing
-
-  class CLI < Thor
-    include Thor::Actions
-
-    class << self
-      attr_accessor :auth_token
-
-      def hyphenate(str)
-        return str.downcase if str =~ /^[A-Z-]+$/
-        str.gsub('_', '-').gsub(/\B[A-Z]/, '-\&').squeeze('-').downcase
-      end
-    end
-
-    attr_accessor :name
-
-    no_tasks do
-      ['widget', 'dashboard', 'job'].each do |type|
-        define_method "generate_#{type}" do |name|
-          @name = Thor::Util.snake_case(name)
-          directory type.to_sym, File.join("#{type}s")
-        end
-      end
-    end
-
-    def self.source_root
-      File.expand_path('../../templates', __FILE__)
-    end
-
-    desc "new PROJECT_NAME", "Sets up ALL THE THINGS needed for your dashboard project."
-    def new(name)
-      @name = Thor::Util.snake_case(name)
-      directory :project, @name
-    end
-
-    desc "generate (widget/dashboard/job) NAME", "Creates a new widget, dashboard, or job."
-    def generate(type, name)
-      send("generate_#{type}".to_sym, name)
-    rescue NoMethodError => e
-      puts "Invalid generator. Either use widget, dashboard, or job"
-    end
-    map "g" => :generate
-
-    desc "install GIST_ID", "Installs a new widget from a gist."
-    def install(gist_id)
-      public_url = "https://gist.github.com/#{gist_id}"
-      gist = JSON.parse(open("https://api.github.com/gists/#{gist_id}").read)
-
-      gist['files'].each do |filename, contents|
-        if filename.end_with?(".rb")
-          create_file File.join(Dir.pwd, 'jobs', filename), contents['content']
-        elsif filename.end_with?(".coffee", ".html", ".scss")
-          widget_name = File.basename(filename, '.*')
-          create_file File.join(Dir.pwd, 'widgets', widget_name, filename), contents['content']
-        end
-      end
-
-      print set_color("Don't forget to edit the ", :yellow)
-      print set_color("Gemfile ", :yellow, :bold)
-      print set_color("and run ", :yellow)
-      print set_color("bundle install ", :yellow, :bold)
-      say set_color("if needed. More information for this widget can be found at #{public_url}", :yellow)
-
-    rescue OpenURI::HTTPError => e
-      say set_color("Could not find gist at #{public_url}"), :red
-    end
-    map "i" => :install
-
-    desc "start", "Starts the server in style!"
-    method_option :job_path, :desc => "Specify the directory where jobs are stored"
-    def start(*args)
-      port_option = args.include?('-p')? '' : ' -p 3030'
-      args = args.join(" ")
-      command = "bundle exec thin -R config.ru start #{port_option} #{args}"
-      command.prepend "export JOB_PATH=#{options[:job_path]}; " if options[:job_path]
-      system(command)
-    end
-    map "s" => :start
-
-    desc "stop", "Stops the thin server"
-    def stop
-      command = "bundle exec thin stop"
-      system(command)
-    end
-    
-    desc "job JOB_NAME AUTH_TOKEN(optional)", "Runs the specified job. Make sure to supply your auth token if you have one set."
-    def job(name, auth_token = "")
-      Dir[File.join(Dir.pwd, 'lib/**/*.rb')].each {|file| require file }
-      self.class.auth_token = auth_token
-      f = File.join(Dir.pwd, "jobs", "#{name}.rb")
-      require f
-    end
-
-  end
-end
-
-Dashing::CLI.start
+require 'dashing'
+Dashing::CLI.source_root(File.expand_path('../../templates', bin_file))
+Dashing::CLI.start(ARGV)

dashing.gemspec

@@ -11,20 +11,25 @@ Gem::Specification.new do |s|
   s.description = "This framework lets you build & easily layout dashboards with your own custom widgets. Use it to make a status boards for your ops team, or use it to track signups, conversion rates, or whatever else metrics you'd like to see in one spot. Included with the framework are ready-made widgets for you to use or customize. All of this code was extracted out of a project at Shopify that displays dashboards on TVs around the office."
   s.author      = "Daniel Beauchamp"
   s.email       = '[email protected]'
-  s.files       = ["lib/Dashing.rb"]
   s.homepage    = 'http://shopify.github.com/dashing'
 
   s.files = Dir['README.md', 'javascripts/**/*', 'templates/**/*','templates/**/.[a-z]*', 'lib/**/*']
 
-  s.add_dependency('sass')
-  s.add_dependency('coffee-script', '>=1.6.2')
-  s.add_dependency('execjs', '>=2.0.0')
-  s.add_dependency('sinatra')
-  s.add_dependency('sinatra-contrib')
-  s.add_dependency('thin')
-  s.add_dependency('rufus-scheduler', '~> 2.0')
-  s.add_dependency('thor')
-  s.add_dependency('sprockets')
-  s.add_dependency('rack')
+  s.add_dependency('sass', '~> 3.2.12')
+  s.add_dependency('coffee-script', '~> 2.2.0')
+  s.add_dependency('execjs', '~> 2.0.2')
+  s.add_dependency('sinatra', '~> 1.4.4')
+  s.add_dependency('sinatra-contrib', '~> 1.4.2')
+  s.add_dependency('thin', '~> 1.6.1')
+  s.add_dependency('rufus-scheduler', '~> 3.0.3')
+  s.add_dependency('thor', '~> 0.18.1')
+  s.add_dependency('sprockets', '~> 2.10.1')
+  s.add_dependency('rack', '~> 1.5.2')
 
-end
+  s.add_development_dependency('rake', '~> 10.1.0')
+  s.add_development_dependency('haml', '~> 4.0.4')
+  s.add_development_dependency('minitest', '~> 5.2.0')
+  s.add_development_dependency('mocha', '~> 0.14.0')
+  s.add_development_dependency('fakeweb', '~> 1.3.0')
+  s.add_development_dependency('simplecov', '~> 0.8.2')
+end

lib/dashing.rb

@@ -1,167 +1,6 @@
-require 'sinatra'
-require 'sprockets'
-require 'sinatra/content_for'
-require 'rufus/scheduler'
-require 'coffee-script'
-require 'sass'
-require 'json'
-require 'yaml'
+require 'dashing/cli'
+require 'dashing/downloader'
+require 'dashing/app'
 
-SCHEDULER = Rufus::Scheduler.start_new
-
-set :root, Dir.pwd
-
-set :sprockets,     Sprockets::Environment.new(settings.root)
-set :assets_prefix, '/assets'
-set :digest_assets, false
-['assets/javascripts', 'assets/stylesheets', 'assets/fonts', 'assets/images', 'widgets', File.expand_path('../../javascripts', __FILE__)]. each do |path|
-  settings.sprockets.append_path path
-end
-
-set server: 'thin', connections: [], history_file: 'history.yml'
-
-# Persist history in tmp file at exit
-at_exit do
-  File.open(settings.history_file, 'w') do |f|
-    f.puts settings.history.to_yaml
-  end
-end
-
-if File.exists?(settings.history_file)
-  set history: YAML.load_file(settings.history_file)
-else
-  set history: {}
-end
-
-set :public_folder, File.join(settings.root, 'public')
-set :views, File.join(settings.root, 'dashboards')
-set :default_dashboard, nil
-set :auth_token, nil
-
-helpers Sinatra::ContentFor
-helpers do
-  def protected!
-    # override with auth logic
-  end
-end
-
-get '/events', provides: 'text/event-stream' do
-  protected!
-  response.headers['X-Accel-Buffering'] = 'no' # Disable buffering for nginx
-  stream :keep_open do |out|
-    settings.connections << out
-    out << latest_events
-    out.callback { settings.connections.delete(out) }
-  end
-end
-
-get '/' do
-  protected!
-  begin
-  redirect "/" + (settings.default_dashboard || first_dashboard).to_s
-  rescue NoMethodError => e
-    raise Exception.new("There are no dashboards in your dashboard directory.")
-  end
-end
-
-get '/:dashboard' do
-  protected!
-  tilt_html_engines.each do |suffix, _|
-    file = File.join(settings.views, "#{params[:dashboard]}.#{suffix}")
-    return render(suffix.to_sym, params[:dashboard].to_sym) if File.exist? file
-  end
-
-  halt 404
+module Dashing
 end
-
-get '/views/:widget?.html' do
-  protected!
-  tilt_html_engines.each do |suffix, engines|
-    file = File.join(settings.root, "widgets", params[:widget], "#{params[:widget]}.#{suffix}")
-    return engines.first.new(file).render if File.exist? file
-  end
-end
-
-post '/dashboards/:id' do
-  request.body.rewind
-  body = JSON.parse(request.body.read)
-  body['dashboard'] ||= params['id']
-  auth_token = body.delete("auth_token")
-  if !settings.auth_token || settings.auth_token == auth_token
-    send_event(params['id'], body, 'dashboards')
-    204 # response without entity body
-  else
-    status 401
-    "Invalid API key\n"
-  end
-end
-
-post '/widgets/:id' do
-  request.body.rewind
-  body = JSON.parse(request.body.read)
-  auth_token = body.delete("auth_token")
-  if !settings.auth_token || settings.auth_token == auth_token
-    send_event(params['id'], body)
-    204 # response without entity body
-  else
-    status 401
-    "Invalid API key\n"
-  end
-end
-
-not_found do
-  send_file File.join(settings.public_folder, '404.html')
-end
-
-def development?
-  ENV['RACK_ENV'] == 'development'
-end
-
-def production?
-  ENV['RACK_ENV'] == 'production'
-end
-
-def send_event(id, body, target=nil)
-  body[:id] = id
-  body[:updatedAt] ||= Time.now.to_i
-  event = format_event(body.to_json, target)
-  Sinatra::Application.settings.history[id] = event unless target == 'dashboards'
-  Sinatra::Application.settings.connections.each { |out| out << event }
-end
-
-def format_event(body, name=nil)
-  str = ""
-  str << "event: #{name}\n" if name
-  str << "data: #{body}\n\n"
-end
-
-def latest_events
-  settings.history.inject("") do |str, (id, body)|
-    str << body
-  end
-end
-
-def first_dashboard
-  files = Dir[File.join(settings.views, '*')].collect { |f| File.basename(f, '.*') }
-  files -= ['layout']
-  files.sort.first
-end
-
-def tilt_html_engines
-  Tilt.mappings.select do |_, engines|
-    default_mime_type = engines.first.default_mime_type
-    default_mime_type.nil? || default_mime_type == 'text/html'
-  end
-end
-
-settings_file = File.join(settings.root, 'config/settings.rb')
-if (File.exists?(settings_file))
-  require settings_file
-end
-
-Dir[File.join(settings.root, 'lib', '**', '*.rb')].each {|file| require file }
-{}.to_json # Forces your json codec to initialize (in the event that it is lazily loaded). Does this before job threads start.
-
-job_path = ENV["JOB_PATH"] || 'jobs'
-files = Dir[File.join(settings.root, job_path, '**', '/*.rb')]
-files.each { |job| require(job) }